cuongpv/faveo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

laravel-6 support

Browse Source
This commit is contained in:
RafficMohammed
2023-01-08 01:17:22 +05:30
parent 1a5c16ae4b
commit 774eed8b0e
4962 changed files with 279380 additions and 297961 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
vendor/sly/notification-pusher/doc/getting-started.md vendored
View File

@@ -1,95 +0,0 @@
# NotificationPusher - Documentation
## Getting started
**NOTE** If you want even easier start, please check our facades
* [Facades](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/facades.md)
First, we are going to discover this library entities:
* Models (messages, pushes, devices)
* Adapters (APNS, GCM (FCM) etc.)
* The Manager
Here is the basic principle of a notification push:
A **push** has 3 main elements: a composed **message**, some defined **devices** to notify
and an **adapter** matching with these devices.
The **manager** has to collect all push notifications and send them.
Here is how to translate this with code (just a little not-working example):
``` php
<?php
// First, instantiate the manager and declare an adapter.
$pushManager = new Sly\NotificationPusher\PushManager();
$exampleAdapter = new Sly\NotificationPusher\Adapter\Apns();
// Set the device(s) to push the notification to.
$devices = new Sly\NotificationPusher\Collection\DeviceCollection(array(
new Sly\NotificationPusher\Model\Device('Token1'),
new Sly\NotificationPusher\Model\Device('Token2'),
new Sly\NotificationPusher\Model\Device('Token3'),
// ...
));
// Then, create the push skel.
$message = new Sly\NotificationPusher\Model\Message('This is an example.');
// Finally, create and add the push to the manager, and push it!
$push = new Sly\NotificationPusher\Model\Push($exampleAdapter, $devices, $message);
$pushManager->add($push);
$pushManager->push();
foreach($push->getResponses() as $token => $response) {
// ...
}
```
## More about the Message entity
Some general options can be passed to the message entity and be used by adapters.
A message pushed from APNS adapter can comport a "badge" or "sound" information which will be set with
instance constructor second argument:
``` php
<?php
$message = new Sly\NotificationPusher\Model\Message('This is an example.', array(
'badge' => 1,
'sound' => 'example.aiff',
// ...
));
```
## More about the Device entity
The device can comport some dedicated informations that could be used by adapters.
For example, APNS adapter could want to know a device badge status for incrementing it with message's one.
Here is an example of this:
``` php
<?php
$message = new Sly\NotificationPusher\Model\Message('This is an example.', array(
'badge' => 1,
// ...
));
$devices = new Sly\NotificationPusher\Collection\DeviceCollection(array(
new Sly\NotificationPusher\Model\Device('Token1', array('badge' => 5)),
// ...
));
```
## Documentation index
* [Installation](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/installation.md)
* Getting started
* [APNS adapter](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/apns-adapter.md)
* [GCM (FCM) adapter](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/gcm-fcm-adapter.md)
* [Create an adapter](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/create-an-adapter.md)
* [Push from CLI](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/push-from-cli.md)
* [Facades](https://github.com/Ph3nol/NotificationPusher/blob/master/doc/facades.md)