Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 3.09 KB

getting-started.md

File metadata and controls

95 lines (70 loc) · 3.09 KB
Raw

NotificationPusher - Documentation

Getting started

NOTE If you want even easier start, please check our facades

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

// 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

$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

$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