joearcher / pooshlaravel
Poosh push messaging facade for Laravel 5
Installs: 577
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Type:api
Requires
- guzzlehttp/guzzle: ~5.2
- laravel/framework: ~5
This package is not auto-updated.
Last update: 2024-11-23 17:21:13 UTC
README
Super simple facade to send push messages via a Poosh server.
Setup
Require this package in composer.json and run composer update
"joearcher/pooshlaravel": "dev-master"
After updating add the ServiceProvider the the providers array in config/app.php
'Joearcher\Pooshlaravel\PooshlaravelServiceProvider',
And then you can add the facade to the Facades array
'Poosh' => 'Joearcher\Pooshlaravel\Facades\Poosh',
Publish the config
artisan vendor:publish
This creates a poosh.php
file in config/
, we recommend setting these options via your .env file
POOSH_SECRET
- This is the shared secret it needs to be the same as the one set on your Poosh server.
POOSH_URL
- The full url including the protocol to your Poosh server, e.g. http://poosh.blaa
.
POOSH_PORT
- The server port set on your Poosh server (Default is 1337).
Usage
This facade currently provides one method which requires 2 parameters.
Poosh::send($event,$payload)
$event
must be a string
, this is the name of the event to fire on the client. $payload
must be an array()
and is the payload to be sent to all clients listening for the event.
Poosh::send('message',['body' => 'This is a message']);
Thanks
Made possible by the awesome Guzzle Http client