Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mac-cain13/notificato

Takes care of Apple push notifications (APNS) in your PHP projects.
https://github.com/mac-cain13/notificato

apple ios php push-notifications symfony

Last synced: 8 days ago
JSON representation

Takes care of Apple push notifications (APNS) in your PHP projects.

Awesome Lists containing this project

README 

        
# Notificato [![Build Status of Master](https://travis-ci.org/mac-cain13/notificato.png?branch=master)](https://travis-ci.org/mac-cain13/notificato)

**Notificato takes care of push notifications in your PHP projects.**



> *Italian:* **notificato** è: participio passato *English:* **notified**



## Why use Notificato instead of X?

Notificato has some advantages not all other PHP push libraries have:



1. Supports multiple APNS certificates, so you can push to multiple Apps/Passbook Passes

2. Takes excellent care of PHPs buggy SSL-sockets, handles quirks and error responses correctly

3. Well tested with unit tests and nice Object-Oriented structure



## Installation

Installation with [Composer](http://getcomposer.org) is recommended. Run the require command to add Notificato to your project:



`composer require wrep/notificato`



*Suggestion:*

There is also a [Notificato for Symfony bundle](https://github.com/rickpastoor/notificato-symfony) available, highly recommended for Symfony2 & Symfony3 users.



## Getting started

1. Take a look at the snippet below for a impression how Notificato works

2. [Read the documentation](/doc/Readme.md) it will help you with common use cases

3. Check out the [API docs](http://mac-cain13.github.io/notificato/master/) for a deeper understanding what Notificato is capable of



```php

messageBuilder()

								->setDeviceToken('ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff')

								->setBadge(1)

								->build();



		// The message is ready, let's send it!

		//  Be aware that this method is blocking and on failure Notificato will retry if necessary

		$messageEnvelope = $notificato->send($message);



		// The returned envelope contains usefull information about how many retries where needed and if sending succeeded

		echo $messageEnvelope->getFinalStatusDescription();

	}



	/**

	 * This example reads all unregistered devices from Apples feedback service

	 */

	public function readFeedbackService()

	{

		// First we get the a Notificato instance and tell it what certificate to use as default certificate

		$notificato = new Notificato('./certificate.pem', 'passphrase-to-use');



		// Now read all "tuples" from the feedback service, be aware that this method is blocking

		$tuples = $notificato->receiveFeedback();



		// The tuples contain information about what device unregistered and when it did unregister.

		//  Don't forget to check if the device reregistered after the "invaidated at" date!

		foreach ($tuples as $tuple)

		{

			echo 'Device ' . $tuple->getDeviceToken() . ' invalidated at ' . $tuple->getInvalidatedAt()->format(\DateTime::ISO8601) . PHP_EOL;

		}

	}

}



$gettingStarted = new GettingStarted();

$gettingStarted->sendOnePushNotification();

$gettingStarted->readFeedbackService();

```



## Contribute

We'll love contributions, read [Contribute.md](Contribute.md) for some more info on what you can do and stuff that you should know if you want to help!



## License & Credits

Notificato is released under the [MIT License](License) by [Mathijs Kadijk](https://github.com/mac-cain13), so feel free to use it in commercial and non-commercial projects.