PHP Class RakutenRws_ApiResponse

Inheritance: implements IteratorAggregate, implements ArrayAccess
Mostrar archivo Open project: rakuten-ws/rws-php-sdk

Protected Properties

Property Type Description
$code
$data
$httpResponse
$isOk
$iterator
$message
$operation

Public Methods

Method Description
__construct ( string $operation, RakutenRws_HttpResponse $response ) Constructor
getCode ( ) : integer Gets the status code
getData ( ) : mixed Gets response data
getHttpResponse ( ) : RakutenRws_HttpResponse Gets the HttpResponse
getIterator ( ) : Iterator Gets the iterator
getMessage ( ) : string Gets the response message
getOperation ( ) : string Gets the operation
hasIterator ( ) : boolean Check response has the iterator
isOk ( ) : boolean Returns if request is successful.
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
setIterator ( $data ) Sets iterator

Protected Methods

Method Description
handleResponse ( )

Method Details

__construct() public method

Constructor
public __construct ( string $operation, RakutenRws_HttpResponse $response )
$operation string The operation
$response RakutenRws_HttpResponse

getCode() public method

Gets the status code
public getCode ( ) : integer
return integer

getData() public method

Gets response data
public getData ( ) : mixed
return mixed

getHttpResponse() public method

Gets the HttpResponse
public getHttpResponse ( ) : RakutenRws_HttpResponse
return RakutenRws_HttpResponse

getIterator() public method

Gets the iterator
public getIterator ( ) : Iterator
return Iterator

getMessage() public method

Gets the response message
public getMessage ( ) : string
return string

getOperation() public method

Gets the operation
public getOperation ( ) : string
return string

handleResponse() abstract protected method

abstract protected handleResponse ( )

hasIterator() public method

Check response has the iterator
public hasIterator ( ) : boolean
return boolean

isOk() public method

Returns if request is successful.
public isOk ( ) : boolean
return boolean

offsetExists() public method

public offsetExists ( $offset )

offsetGet() public method

public offsetGet ( $offset )

offsetSet() public method

public offsetSet ( $offset, $value )

offsetUnset() public method

public offsetUnset ( $offset )

setIterator() public method

Sets iterator
public setIterator ( $data )

Property Details

$code protected_oe property

protected $code

$data protected_oe property

protected $data

$httpResponse protected_oe property

protected $httpResponse

$isOk protected_oe property

protected $isOk

$iterator protected_oe property

protected $iterator

$message protected_oe property

protected $message

$operation protected_oe property

protected $operation