Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Zend_Mobile_Push_Response_Gcm Class Reference

Public Member Functions

 __construct ($responseString=null, Zend_Mobile_Push_Message_Gcm $message=null)
 Constructor.
 
 getMessage ()
 Get Message.
 
 setMessage (Zend_Mobile_Push_Message_Gcm $message)
 Set Message.
 
 getResponse ()
 Get Response.
 
 setResponse (array $response)
 Set Response.
 
 getSuccessCount ()
 Get Success Count.
 
 getFailureCount ()
 Get Failure Count.
 
 getCanonicalCount ()
 Get Canonical Count.
 
 getResults ()
 Get Results.
 
 getResult ($flag)
 Get Singular Result.
 

Public Attributes

const RESULT_MESSAGE_ID = 'message_id'
 
const RESULT_ERROR = 'error'
 
const RESULT_CANONICAL = 'registration_id'
 

Protected Member Functions

 _correlate ()
 Correlate Message and Result.
 

Protected Attributes

 $_id
 
 $_successCnt
 
 $_failureCnt
 
 $_canonicalCnt
 
 $_message
 
 $_results
 
 $_response
 

Constructor & Destructor Documentation

__construct (   $responseString = null,
Zend_Mobile_Push_Message_Gcm  $message = null 
)

Constructor.

Parameters
string$responseStringJSON encoded response
Zend_Mobile_Push_Message_Gcm$message
Returns
Zend_Mobile_Push_Response_Gcm
Exceptions
Zend_Mobile_Push_Exception_ServerUnavailable

Member Function Documentation

_correlate ( )
protected

Correlate Message and Result.

Returns
array
getCanonicalCount ( )

Get Canonical Count.

Returns
int
getFailureCount ( )

Get Failure Count.

Returns
int
getMessage ( )

Get Message.

Returns
Zend_Mobile_Push_Message_Gcm
getResponse ( )

Get Response.

Returns
array
getResult (   $flag)

Get Singular Result.

Parameters
int$flagone of the RESULT_* flags
Returns
array singular array with keys being registration id value is the type of result
getResults ( )

Get Results.

Returns
array multi dimensional array of: NOTE: key is registration_id if the message is passed. 'registration_id' => array( 'message_id' => 'id', 'error' => 'error', 'registration_id' => 'id' )
getSuccessCount ( )

Get Success Count.

Returns
int
setMessage ( Zend_Mobile_Push_Message_Gcm  $message)

Set Message.

Parameters
Zend_Mobile_Push_Message_Gcm$message
Returns
Zend_Mobile_Push_Response_Gcm
setResponse ( array  $response)

Set Response.

Parameters
array$response
Returns
Zend_Mobile_Push_Response_Gcm

Member Data Documentation

$_canonicalCnt
protected
$_failureCnt
protected
$_id
protected
$_message
protected
$_response
protected
$_results
protected
$_successCnt
protected
const RESULT_CANONICAL = 'registration_id'
const RESULT_ERROR = 'error'
const RESULT_MESSAGE_ID = 'message_id'