PHP Class QueryAuth\Request\RequestValidator

Show file Open project: jeremykendall/query-auth Class Usage Examples

Public Methods

Method	Description
__construct ( QueryAuth\SignatureInterface $signature )	Public constructor
getDrift ( ) : integer	Get drift
getSignature ( ) : Signature	Get Signature
isValid ( QueryAuth\Request\RequestInterface $request, QueryAuth\Credentials\CredentialsInterface $credentials ) : boolean	Is signature valid?
setDrift ( integer $drift )	Set drift
setSignature ( QueryAuth\SignatureInterface $signature )	Set Signature

Protected Methods

Method	Description
isDriftExceeded ( array $params ) : boolean	Is $timestamp greater than or less than $drift seconds?
isSignaturePresent ( array $params )	Throws exception if signature is not present in request
isTimestampPresent ( array $params )	Throws exception if timestamp is not present in request

Method Details

__construct() public method

Public constructor

public __construct ( QueryAuth\SignatureInterface $signature )
$signature	QueryAuth\SignatureInterface	Instance of the signature creation interface

getDrift() public method

Get drift

public getDrift ( ) : integer
return	integer	$drift Permissible drift in seconds

getSignature() public method

Get Signature

public getSignature ( ) : Signature
return	Signature	Instance of the signature creation class

isDriftExceeded() protected method

Is $timestamp greater than or less than $drift seconds?

protected isDriftExceeded ( array $params ) : boolean
$params	array	Request params
return	boolean

isSignaturePresent() protected method

Throws exception if signature is not present in request

protected isSignaturePresent ( array $params )
$params	array	Request params

isTimestampPresent() protected method

Throws exception if timestamp is not present in request

protected isTimestampPresent ( array $params )
$params	array	Request params

isValid() public method

Is signature valid?

public isValid ( QueryAuth\Request\RequestInterface $request, QueryAuth\Credentials\CredentialsInterface $credentials ) : boolean
$request	QueryAuth\Request\RequestInterface	Request
$credentials	QueryAuth\Credentials\CredentialsInterface	Credentials
return	boolean

setDrift() public method

Set drift

public setDrift ( integer $drift )
$drift	integer	Permissible drift in seconds

setSignature() public method

Set Signature

public setSignature ( QueryAuth\SignatureInterface $signature )
$signature	QueryAuth\SignatureInterface	Instance of the signature creation class