PHP Class LaravelFCM\Response\DownstreamResponse

Inheritance: extends BaseResponse, implements LaravelFCM\Response\DownstreamResponseContract
Show file Open project: brozot/laravel-fcm Class Usage Examples

Protected Properties

Property Type Description
$hasMissingToken boolean
$messageId
$numberTokenModify integer
$numberTokensFailure integer
$numberTokensSuccess integer
$tokensToDelete array
$tokensToModify array
$tokensToRetry array
$tokensWithError array

Public Methods

Method Description
__construct ( Response $response, $tokens ) DownstreamResponse constructor.
hasMissingToken ( ) : boolean check if missing tokens was given to the request If true, remove all the empty token in your database
merge ( DownstreamResponse $response ) Merge two response
numberFailure ( ) : integer Get the number of device which thrown an error
numberModification ( ) : integer Get the number of device that you need to modify their token
numberSuccess ( ) : integer Get the number of device reached with success
tokensToDelete ( ) : array get token to delete
tokensToModify ( ) : array get token to modify
tokensToRetry ( ) : array Get tokens that you should resend using exponential backoof
tokensWithError ( ) : array Get tokens that thrown an error

Protected Methods

Method Description
logResponse ( )
parseResponse ( $responseInJson ) Parse the response

Private Methods

Method Description
checkMissingToken ( $result ) : boolean
isSent ( $results ) : boolean
needResultParsing ( $responseInJson ) : boolean
needToAddError ( $index, $result )
needToBeDeleted ( $index, $result ) : boolean
needToBeModify ( $index, $result ) : boolean
needToResend ( $index, $result ) : boolean
parse ( $responseInJson )
parseResult ( $responseInJson )

Method Details

__construct() public method

DownstreamResponse constructor.
public __construct ( Response $response, $tokens )
$response GuzzleHttp\Psr7\Response
$tokens

hasMissingToken() public method

check if missing tokens was given to the request If true, remove all the empty token in your database
public hasMissingToken ( ) : boolean
return boolean

logResponse() protected method

protected logResponse ( )

merge() public method

Merge two response
public merge ( DownstreamResponse $response )
$response DownstreamResponse

numberFailure() public method

Get the number of device which thrown an error
public numberFailure ( ) : integer
return integer

numberModification() public method

Get the number of device that you need to modify their token
public numberModification ( ) : integer
return integer

numberSuccess() public method

Get the number of device reached with success
public numberSuccess ( ) : integer
return integer

parseResponse() protected method

Parse the response
protected parseResponse ( $responseInJson )
$responseInJson

tokensToDelete() public method

remove all tokens returned by this method in your database
public tokensToDelete ( ) : array
return array

tokensToModify() public method

key: oldToken value: new token find the old token in your database and replace it with the new one
public tokensToModify ( ) : array
return array

tokensToRetry() public method

Get tokens that you should resend using exponential backoof
public tokensToRetry ( ) : array
return array

tokensWithError() public method

key : token value : error In production, remove these tokens from you database
public tokensWithError ( ) : array
return array

Property Details

$hasMissingToken protected property

protected bool $hasMissingToken
return boolean

$messageId protected property

protected $messageId

$numberTokenModify protected property

protected int $numberTokenModify
return integer

$numberTokensFailure protected property

protected int $numberTokensFailure
return integer

$numberTokensSuccess protected property

protected int $numberTokensSuccess
return integer

$tokensToDelete protected property

protected array $tokensToDelete
return array

$tokensToModify protected property

protected array $tokensToModify
return array

$tokensToRetry protected property

protected array $tokensToRetry
return array

$tokensWithError protected property

protected array $tokensWithError
return array