richsage / rms-push-notifications-bundle
Push notifications/messages for mobile devices
Installs: 904 017
Dependents: 4
Suggesters: 0
Security: 0
Stars: 332
Watchers: 27
Forks: 156
Open Issues: 57
Type:symfony-bundle
Requires
- php: >=5.3.0
- kriswallsmith/buzz: *
- psr/log: ^1.0
Requires (Dev)
- symfony/symfony: ^2.0 || ^3.0
Suggests
- symfony/symfony: To use as a bundle
This package is auto-updated.
Last update: 2021-06-23 20:56:05 UTC
README
A bundle to allow sending of push notifications to mobile devices. Currently supports Android (C2DM, GCM), Blackberry and iOS devices.
Installation
To use this bundle in your Symfony2 project add the following to your composer.json
:
{
"require": {
// ...
"richsage/rms-push-notifications-bundle": "dev-master"
}
}
and enable it in your kernel:
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new RMS\PushNotificationsBundle\RMSPushNotificationsBundle(),
);
}
NOTE: If you are still using Symfony 2.0, please use the symfony2.0
branch.
Configuration
Configuration options available are as follows. Note that the specific services will only be available if you provide configuration respectively for them.
rms_push_notifications:
android:
timeout: 5 # Seconds to wait for connection timeout, default is 5
c2dm:
username: <string_android_c2dm_username>
password: <string_android_c2dm_password>
source: <string_android_c2dm_source>
gcm:
api_key: <string_android_gcm_api_key> # This is titled "Server Key" when creating it
use_multi_curl: <boolean_android_gcm_use_multi_curl> # default is true
dry_run: <bool_use_gcm_dry_run>
ios:
timeout: 60 # Seconds to wait for connection timeout, default is 60
sandbox: <bool_use_apns_sandbox>
pem: <path_apns_certificate> # can be absolute or relative path (from app directory)
passphrase: <string_apns_certificate_passphrase>
mac:
timeout: 60 # Seconds to wait for connection timeout, default is 60
sandbox: <bool_use_apns_sandbox>
pem: <path_apns_certificate>
passphrase: <string_apns_certificate_passphrase>
blackberry:
timeout: 5 # Seconds to wait for connection timeout, default is 5
evaluation: <bool_bb_evaluation_mode>
app_id: <string_bb_app_id>
password: <string_bb_password>
windowsphone:
timeout: 5 # Seconds to wait for connection timeout, default is 5
NOTE: If you are using Windows, you may need to set the Android GCM use_multi_curl
flag to false for GCM messages to be sent correctly.
Timeout defaults are the defaults from prior to the introduction of this configuration value.
Usage
A little example of how to push your first message to an iOS device, we'll assume that you've set up the configuration correctly:
use RMS\PushNotificationsBundle\Message\iOSMessage;
class PushDemoController extends Controller
{
public function pushAction()
{
$message = new iOSMessage();
$message->setMessage('Oh my! A push notification!');
$message->setDeviceIdentifier('test012fasdf482asdfd63f6d7bc6d4293aedd5fb448fe505eb4asdfef8595a7');
$this->container->get('rms_push_notifications')->send($message);
return new Response('Push notification send!');
}
}
The send method will detect the type of message so if you'll pass it an AndroidMessage
it will automatically send it through the C2DM/GCM servers, and likewise for Mac and Blackberry.
Android messages
Since both C2DM and GCM are still available, the AndroidMessage
class has a small flag on it to toggle which service to send it to. Use as follows:
use RMS\PushNotificationsBundle\Message\AndroidMessage;
$message = new AndroidMessage();
$message->setGCM(true);
to send as a GCM message rather than C2DM.
iOS Feedback service
The Apple Push Notification service also exposes a Feedback service where you can get information about failed push notifications - see here for further details.
This service is available within the bundle. The following code demonstrates how you can retrieve data from the service:
$feedbackService = $container->get("rms_push_notifications.ios.feedback");
$uuids = $feedbackService->getDeviceUUIDs();
Here, $uuids
contains an array of Feedback objects, with timestamp, token length and the device UUID all populated.
Apple recommend you poll this service daily.
Windows Phone - Toast support
The bundle has beta support for Windows Phone, and supports the Toast notification. Use the WindowsphoneMessage
message class to send accordingly.
Thanks
Firstly, thanks to all contributors to this bundle!
Secondly, thanks to JetBrains for their sponsorship of an open-source PhpStorm licence for this project.