Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
WebServiceRequest Class Reference

Public Member Functions

 getAccept ()
 
 getAsync ()
 
 getCleanResult ()
 
 getHeaders ()
 
 getMethod ()
 
getParams ()
 
 getUrl ()
 
 hasHeader ($header)
 
 setAccept ($accept)
 
 setAsync ($async)
 
 setCleanResult ($cleanResult)
 
 setHeader ($header, $content)
 
 setMethod ($method)
 
 setParams (&$params)
 
 setUrl ($url)
 
 WebServiceRequest ($url, $params=array(), $method= 'GET')
 

Detailed Description

Represents a web service request.

Definition at line 17 of file WebServiceRequest.inc.php.

Member Function Documentation

WebServiceRequest::getAccept ( )

Get the accept header value

Returns
string

Definition at line 112 of file WebServiceRequest.inc.php.

WebServiceRequest::getAsync ( )

Whether to make an async request.

Returns
boolean

Definition at line 161 of file WebServiceRequest.inc.php.

WebServiceRequest::getCleanResult ( )

Get whether to clean the request result.

Returns
boolean

Definition at line 177 of file WebServiceRequest.inc.php.

WebServiceRequest::getHeaders ( )

Get additional request headers.

Definition at line 144 of file WebServiceRequest.inc.php.

WebServiceRequest::getMethod ( )

Get the request method

Returns
string

Definition at line 88 of file WebServiceRequest.inc.php.

& WebServiceRequest::getParams ( )

Get the request parameters

Returns
array

Definition at line 72 of file WebServiceRequest.inc.php.

WebServiceRequest::getUrl ( )

Get the web service URL

Returns
string

Definition at line 56 of file WebServiceRequest.inc.php.

WebServiceRequest::hasHeader (   $header)

Check whether the given header is present in the request.

The check is case insensitive.

Parameters
$headerstring

Definition at line 133 of file WebServiceRequest.inc.php.

WebServiceRequest::setAccept (   $accept)

Set the accept header value

Parameters
$acceptstring

Definition at line 104 of file WebServiceRequest.inc.php.

WebServiceRequest::setAsync (   $async)

Set whether to make an async request. (POST requests only)

Parameters
$asyncboolean

Definition at line 153 of file WebServiceRequest.inc.php.

WebServiceRequest::setCleanResult (   $cleanResult)

Whether to clean the request result.

Parameters
$cleanResult

Definition at line 169 of file WebServiceRequest.inc.php.

WebServiceRequest::setHeader (   $header,
  $content 
)

Set an additional request header.

Parameters
$headerstring
$contentstring

Definition at line 121 of file WebServiceRequest.inc.php.

WebServiceRequest::setMethod (   $method)

Set the request method

Parameters
$methodstring

Definition at line 96 of file WebServiceRequest.inc.php.

WebServiceRequest::setParams ( $params)

Set the request parameters

Parameters
$paramsarray

Definition at line 80 of file WebServiceRequest.inc.php.

WebServiceRequest::setUrl (   $url)

Set the web service URL

Parameters
$urlstring

Definition at line 64 of file WebServiceRequest.inc.php.

WebServiceRequest::WebServiceRequest (   $url,
  $params = array(),
  $method = 'GET' 
)

Constructor

Definition at line 42 of file WebServiceRequest.inc.php.


The documentation for this class was generated from the following file: