Class shardimage\shardimagephpapi\web\requests\BaseRequest

All Classes | Properties | Methods

Inheritance	shardimage\shardimagephpapi\web\requests\BaseRequest
Subclasses	shardimage\shardimagephpapi\web\requests\CustomRequest, shardimage\shardimagephpapi\web\requests\FileRequest, shardimage\shardimagephpapi\web\requests\MultipartRequest, shardimage\shardimagephpapi\web\requests\PollRequest, shardimage\shardimagephpapi\web\requests\RestRequest

Extendable request handler.

Protected Properties

Property	Type	Description	Defined By
$request	shardimage\shardimagephpapi\api\Request	API request object	shardimage\shardimagephpapi\web\requests\BaseRequest
$service	shardimage\shardimagephpapi\services\Client\|shardimage\shardimagephpapi\services\Server	Service	shardimage\shardimagephpapi\web\requests\BaseRequest

Method	Description	Defined By
__construct()	Creates the request handler.	shardimage\shardimagephpapi\web\requests\BaseRequest
getBody()	Returns the body.	shardimage\shardimagephpapi\web\requests\BaseRequest
getHeaders()	Returns the headers in array.	shardimage\shardimagephpapi\web\requests\BaseRequest
getMethod()	Returns the HTTP method.	shardimage\shardimagephpapi\web\requests\BaseRequest
getUri()	Returns the uri after replacing the parameters.	shardimage\shardimagephpapi\web\requests\BaseRequest

Method	Description	Defined By
buildUri()	Builds the uri.	shardimage\shardimagephpapi\web\requests\BaseRequest
formatUriParam()		shardimage\shardimagephpapi\web\requests\BaseRequest
parseUrlParams()		shardimage\shardimagephpapi\web\requests\BaseRequest
prepareUrlReplaceParams()	Prepares replace array	shardimage\shardimagephpapi\web\requests\BaseRequest

$request protected property

API request object

$service protected property

Service

__construct() public method

Creates the request handler.

public void __construct ( $service, $request )
$service	shardimage\shardimagephpapi\services\Client\|shardimage\shardimagephpapi\services\Server	Service
$request	shardimage\shardimagephpapi\api\Request	API request

buildUri() protected method

Builds the uri.

protected string buildUri ( )
throws	shardimage\shardimagephpapi\base\exceptions\InvalidCallException

formatUriParam() protected method

protected void formatUriParam ( $param, $value )
$param
$value

getBody() public method

Returns the body.

public string getBody ( )

getHeaders() public method

Returns the headers in array.

public array getHeaders ( )

getMethod() public method

Returns the HTTP method.

public string getMethod ( )

getUri() public method

Returns the uri after replacing the parameters.

public string getUri ( )

parseUrlParams() protected static method

protected static void parseUrlParams ( $uri )
$uri

prepareUrlReplaceParams() protected method

Prepares replace array

protected void prepareUrlReplaceParams ( &$replace, $findKey, $paramValue )
$replace	array
$findKey	string
$paramValue	string