Google Cloud Messaging (GCM) PHP Server Library

A PHP library for sending messages to devices registered through Google Cloud Messaging.

See: http://developer.android.com/guide/google/gcm/index.html

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
    ->setNotification(array("title" => "foo", "body" => "bar"))
    ->setCollapseKey("collapse_key")
    ->setDelayWhileIdle(true)
    ->setTtl(123)
    ->setRestrictedPackageName("com.example.trololo")
    ->setDryRun(true)
;

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) {
    
        if ($response->getExistsInvalidDataKey()) {
            //You used a reserved data key
            $error_msg = 'Invalid data key in payload. ' . json_encode($message->getNotification());
            throw new Exception($error_msg, Exception::INVALID_DATA_KEY);
        }
        
        if ($response->getExistsMismatchSenderId()) {
            //A client sent the wrong senderId when it registered for pushes
            $error_msg = 'Mismatch senderId. Problem clients are '
                . json_encode($response->getMismatchSenderIdIds());
            throw new Exception($error_msg, Exception::MISMATCH_SENDER_ID);
        } 
    
        $invalidRegistrationIds = $response->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::UNKNOWN_ERROR:
            if ($e->getMustRetry()) {
                $waitSeconds = $e->getWaitSeconds();
                //retry in that many seconds, and use exponential back-off subsequently.
                //TODO
                break;
            }
        case GCM\Exception::ILLEGAL_API_KEY:
        case GCM\Exception::AUTHENTICATION_ERROR:
        case GCM\Exception::MALFORMED_REQUEST:	
        case GCM\Exception::MALFORMED_RESPONSE:
        case GCM\Exception::INVALID_DATA_KEY: //you used a forbidden key in the notification
        case GCM\Exception::MISMATCH_SENDER_ID; //a client sent the wrong senderId when it registered for pushes
            //Deal with it
            break;
    }
}

Also indirect message API available

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) {
    
        if ($response->getExistsInvalidDataKey()) {
            //You used a reserved data key
            $error_msg = 'Invalid data key in payload. ' . json_encode($message->getNotification());
            throw new Exception($error_msg, Exception::INVALID_DATA_KEY);
        }
        
        if ($response->getExistsMismatchSenderId()) {
            //A client sent the wrong senderId when it registered for pushes
            $error_msg = 'Mismatch senderId. Problem clients are '
                . json_encode($response->getMismatchSenderIdIds());
            throw new Exception($error_msg, Exception::MISMATCH_SENDER_ID);
        } 
    
        $invalidRegistrationIds = $response->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::UNKNOWN_ERROR:
            if ($e->getMustRetry()) {
                $waitSeconds = $e->getWaitSeconds();
                //retry in that many seconds, and use exponential back-off subsequently.
                //TODO
                break;
            }
        case GCM\Exception::ILLEGAL_API_KEY:
        case GCM\Exception::AUTHENTICATION_ERROR:
        case GCM\Exception::MALFORMED_REQUEST:	
        case GCM\Exception::MALFORMED_RESPONSE:
        case GCM\Exception::INVALID_DATA_KEY: //you used a forbidden key in the notification
        case GCM\Exception::MISMATCH_SENDER_ID; //a client sent the wrong senderId when it registered for pushes
            //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.

You need to download root certificates and add them somewhere into your project directory. Then construct Sender object like this:

use \CodeMonkeysRu\GCM;

$sender = new GCM\Sender("YOUR GOOGLE API KEY", false, "/path/to/cacert.crt");

ChangeLog

Licensed under MIT license.