zbox/unified-push

Unified Push supports push notifications for iOS, Android and Windows Phone devices via APNs, GCM and MPNS

0.9.2 2016-09-29 17:58 UTC

Requires

• php: >=5.3.2
• kriswallsmith/buzz: *
• psr/log: ^1.0

Suggests

• monolog/monolog: Allows more advanced logging of the application flow

MIT

• Alexander Zhukov

• message
• apple
• notification
• push
• iphone
• android
• gcm
• apns
• apn
• mpns
• windows phone

README

Unified Push supports push notifications for iOS, Android and Windows Phone devices via APNs, GCM and MPNS.

Wiki: UML structure and sequence diagrams.

Install

The recommended way to install UnifiedPush is through composer.

{
    "require": {
	    "zbox/unified-push": "^0.9"
    }
}

Features

• Unified interface that supports sending push notifications for platforms:
  • Apple (APNS)
  • Android (GCM)
  • Windows Phone (MPNS)

Requirements

• PHP 5.3.2 or later
• HTTP client (kriswallsmith/buzz)
• PSR Log (psr/log)
• PHPUnit to run tests

Usage

Configure Notification Services Client Factory

Create service client factory configured with credentials.

<?php

use Zbox\UnifiedPush\NotificationService\ServiceClientFactory;
use Zbox\UnifiedPush\NotificationService\ServiceCredentialsFactory;
use Zbox\UnifiedPush\Utils\ClientCredentials\CredentialsMapper;

$credentialsFactory = 
    new ServiceCredentialsFactory(
        new CredentialsMapper()
    );

$credentials = ['certificate' => 'path', 'certificatePassPhrase' => 'pass'];
$credentialsFactory->addCredentialsForService('APNS', $credentials);

$clientFactory = new ServiceClientFactory($credentialsFactory);
$clientFactory->setDefaultConfigPath();

Initialize Message Dispatcher

Initialize class with client factory, notification builder and response handler.

<?php

use Zbox\UnifiedPush\Dispatcher;
use Zbox\UnifiedPush\Notification\NotificationBuilder;
use Zbox\UnifiedPush\NotificationService\ResponseHandler;

$dispatcher =
    new Dispatcher(
        $clientFactory,
        new NotificationBuilder(),
        new ResponseHandler()
    );

$dispatcher->setDevelopmentMode(true);

Create messages

Create messages of type APNS, GCM, MPNS (Raw, Tile or Toast).

<?php

use Zbox\UnifiedPush\Message\MessageCollection;
use Zbox\UnifiedPush\Message\Type\APNS as APNSMessage;
use Zbox\UnifiedPush\Message\Type\APNSAlert;
use Zbox\UnifiedPush\Message\Type\GCM as GCMMessage;

$message1 = new APNSMessage();
$message1
    ->setAlertDictionary(
        (new APNSAlert)
            ->setActionLocKey('btn')
            ->setLocKey('msg')
            ->setLocArgs([$args])
    )
	->setSound('alert')
	->getBadge('2');

$message1->addRecipient('deviceToken1');

$message2 = new GCMMessage();
$message2
	->setCollapseKey('key')
	->addRecipientIdentifiers(
       new \ArrayIterator([
			'deviceToken1', 
			'deviceToken2'
		])
	)
    ->setPayloadData([
		'keyA' => 'value1',
		'keyB' => 'value2',
    ]);
    
$messages = 
    new MessageCollection([
        $message1, 
        $message2
    ]);

Dispatch messages

Send messages and load feedback.

<?php

$dispatcher
    ->dispatchAll($messages)
    ->loadFeedback();

Status

Handle responses to see a report on dispatch errors.

<?php

$responseHandler = $dispatcher->getResponseHandler();
$responseHandler->handleResponseCollection();

$invalidRecipients  = $responseHandler->getInvalidRecipients();
$messageErrors      = $responseHandler->getMessageErrors();

License

MIT, see LICENSE.