PHP Class ApaiIO\Configuration\GenericConfiguration

Author: Jan Eichhorn ([email protected])

Inheritance: implements ApaiIO\Configuration\ConfigurationInterface

Mostra file Open project: exeu/apai-io Class Usage Examples

Protected Properties

Property	Type	Description
$accessKey	string	The accesskey
$associateTag	string	The associate Tag
$country	string	The country
$request	ApaiIO\Request\RequestInterface	The requestclass By default its set to the provided restful request
$responseTransformer	ApaiIO\ResponseTransformer\ResponseTransformerInterface	The responsetransformerclass By default its set to null which means that no transformer will be applied
$secretKey	string	The string

Public Methods

Method	Description
getAccessKey ( )
getAssociateTag ( )
getCountry ( )
getRequest ( )
getResponseTransformer ( )
getSecretKey ( )
setAccessKey ( string $accessKey ) : GenericConfiguration	Sets the accesskey
setAssociateTag ( string $associateTag ) : GenericConfiguration	Sets the associatetag
setCountry ( string $country ) : GenericConfiguration	Sets and validates the country
setRequest ( ApaiIO\Request\RequestInterface $request ) : GenericConfiguration	Sets the Request.
setResponseTransformer ( ApaiIO\ResponseTransformer\ResponseTransformerInterface $responseTransformer ) : GenericConfiguration	Sets the ResponseTransformer
setSecretKey ( string $secretKey ) : GenericConfiguration	Sets the secretkey

Method Details

getAccessKey() public method

public getAccessKey ( )

getAssociateTag() public method

public getAssociateTag ( )

getCountry() public method

public getCountry ( )

getRequest() public method

public getRequest ( )

getResponseTransformer() public method

public getResponseTransformer ( )

getSecretKey() public method

public getSecretKey ( )

setAccessKey() public method

Sets the accesskey

public setAccessKey ( string $accessKey ) : GenericConfiguration
$accessKey	string
return	GenericConfiguration

setAssociateTag() public method

Sets the associatetag

public setAssociateTag ( string $associateTag ) : GenericConfiguration
$associateTag	string
return	GenericConfiguration

setCountry() public method

Sets and validates the country

public setCountry ( string $country ) : GenericConfiguration
$country	string
return	GenericConfiguration

setRequest() public method

Sets the Request.

public setRequest ( ApaiIO\Request\RequestInterface $request ) : GenericConfiguration
$request	ApaiIO\Request\RequestInterface
return	GenericConfiguration

setResponseTransformer() public method

Sets the ResponseTransformer

public setResponseTransformer ( ApaiIO\ResponseTransformer\ResponseTransformerInterface $responseTransformer ) : GenericConfiguration
$responseTransformer	ApaiIO\ResponseTransformer\ResponseTransformerInterface
return	GenericConfiguration

setSecretKey() public method

Sets the secretkey

public setSecretKey ( string $secretKey ) : GenericConfiguration
$secretKey	string
return	GenericConfiguration

Property Details

$accessKey protected_oe property

The accesskey

protected string $accessKey
return	string

$associateTag protected_oe property

The associate Tag

protected string $associateTag
return	string

$country protected_oe property

The country

protected string $country
return	string

$request protected_oe property

The requestclass By default its set to the provided restful request

protected RequestInterface,ApaiIO\Request $request
return	ApaiIO\Request\RequestInterface

$responseTransformer protected_oe property

The responsetransformerclass By default its set to null which means that no transformer will be applied

protected ResponseTransformerInterface,ApaiIO\ResponseTransformer $responseTransformer
return	ApaiIO\ResponseTransformer\ResponseTransformerInterface

$secretKey protected_oe property

The string

protected string $secretKey
return	string