Open Journal Systems  2.4.4
 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, $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 116 of file WebServiceRequest.inc.php.

WebServiceRequest::getAsync ( )

Whether to make an async request.

Returns
boolean

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

WebServiceRequest::getCleanResult ( )

Get whether to clean the request result.

Returns
boolean

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

WebServiceRequest::getHeaders ( )

Get additional request headers.

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

WebServiceRequest::getMethod ( )

Get the request method

Returns
string

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

& WebServiceRequest::getParams ( )

Get the request parameters

Returns
mixed array (key value pairs) or string

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

WebServiceRequest::getUrl ( )

Get the web service URL

Returns
string

Definition at line 60 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 137 of file WebServiceRequest.inc.php.

WebServiceRequest::setAccept (   $accept)

Set the accept header value

Parameters
$acceptstring

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

WebServiceRequest::setAsync (   $async)

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

Parameters
$asyncboolean

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

WebServiceRequest::setCleanResult (   $cleanResult)

Whether to clean the request result.

Parameters
$cleanResult

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

WebServiceRequest::setHeader (   $header,
  $content 
)

Set an additional request header.

Parameters
$headerstring
$contentstring

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

WebServiceRequest::setMethod (   $method)

Set the request method

Parameters
$methodstring

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

WebServiceRequest::setParams ( $params)

Set the request parameters

Parameters
$paramsmixed array (key value pairs) or string

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

WebServiceRequest::setUrl (   $url)

Set the web service URL

Parameters
$urlstring

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

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

Constructor

Parameters
$urlstring The request URL
$paramsmixed array (key value pairs) or string request parameters
$methodstring GET or POST

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


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