Google Cloud Messaging (GCM) PHP Server Library
A PHP library for sending messages to devices registered through Google Cloud Messaging
, (*1)
See:
http://developer.android.com/guide/google/gcm/index.html, (*2)
Example usage
use \CodeMonkeysRu\GCM;
$sender = new GCM\Sender("YOUR GOOGLE API KEY");
$message = new GCM\Message(
array("device_registration_id1", "device_registration_id2"),
array("data1" => "123", "data2" => "string")
);
$message
->notification(array("title" => "foo", "body" => "bar"))
->setCollapseKey("collapse_key")
->setDelayWhileIdle(true)
->setTtl(123)
->setRestrictedPackageName("com.example.trololo")
->setDryRun(true)
->setPriority(GCM\MessageMessage::PRIORITY_HIGH)
;
try {
$response = $sender->send($message);
if ($response->getNewRegistrationIdsCount() > 0) {
$newRegistrationIds = $response->getNewRegistrationIds();
foreach ($newRegistrationIds as $oldRegistrationId => $newRegistrationId){
//Update $oldRegistrationId to $newRegistrationId in DB
//TODO
}
}
if ($response->getFailureCount() > 0) {
$invalidRegistrationIds = $GCMresponse->getInvalidRegistrationIds();
foreach($invalidRegistrationIds as $invalidRegistrationId) {
//Remove $invalidRegistrationId from DB
//TODO
}
//Schedule to resend messages to unavailable devices
$unavailableIds = $response->getUnavailableRegistrationIds();
//TODO
}
} catch (GCM\Exception $e) {
switch ($e->getCode()) {
case GCM\Exception::ILLEGAL_API_KEY:
case GCM\Exception::AUTHENTICATION_ERROR:
case GCM\Exception::MALFORMED_REQUEST:
case GCM\Exception::UNKNOWN_ERROR:
case GCM\Exception::MALFORMED_RESPONSE:
//Deal with it
break;
}
}
Also indirect message API available, (*3)
use \CodeMonkeysRu\GCM;
$sender = new GCM\Sender("YOUR GOOGLE API KEY");
try {
$response = $sender->sendMessage(
array("device_registration_id1", "device_registration_id2"),
array("data1" => "123", "data2" => "string"),
"collapse_key"
);
if ($response->getNewRegistrationIdsCount() > 0) {
$newRegistrationIds = $response->getNewRegistrationIds();
foreach ($newRegistrationIds as $oldRegistrationId => $newRegistrationId){
//Update $oldRegistrationId to $newRegistrationId in DB
//TODO
}
}
if ($response->getFailureCount() > 0) {
$invalidRegistrationIds = $GCMresponse->getInvalidRegistrationIds();
foreach($invalidRegistrationIds as $invalidRegistrationId) {
//Remove $invalidRegistrationId from DB
//TODO
}
//Schedule to resend messages to unavailable devices
$unavailableIds = $response->getUnavailableRegistrationIds();
//TODO
}
} catch (GCM\Exception $e) {
switch ($e->getCode()) {
case GCM\Exception::ILLEGAL_API_KEY:
case GCM\Exception::AUTHENTICATION_ERROR:
case GCM\Exception::MALFORMED_REQUEST:
case GCM\Exception::UNKNOWN_ERROR:
case GCM\Exception::MALFORMED_RESPONSE:
//Deal with it
break;
}
}
Note about cURL SSL verify peer option
Library has turned off CURLOPT_SSL_VERIFYPEER by default, but you can enable it by passing third parameter into constructor of Sender class., (*4)
You need to download root certificates and add them somewhere into your project directory. Then construct Sender object like this:, (*5)
use \CodeMonkeysRu\GCM;
$sender = new GCM\Sender("YOUR GOOGLE API KEY", false, "/path/to/cacert.crt");
ChangeLog
- v0.5 - Added support for "priority" flag (https://github.com/CodeMonkeysRu/GCMMessage/pull/16)
- v0.4 - Code cleanup, PHP5.5 support dropped
- v0.3 - Content-available added (https://github.com/CodeMonkeysRu/GCMMessage/pull/11)
- v0.2 - Notifications added
- v0.1 - Initial release
Licensed under MIT license., (*6)
Wallogit.com
