Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($url, $params, $method='GET', $useProxy=true) | |
getAccept () | |
getAsync () | |
getHeaders () | |
getMethod () | |
& | getParams () |
getUrl () | |
getUseProxySettings () | |
hasHeader ($header) | |
setAccept ($accept) | |
setAsync ($async) | |
setHeader ($header, $content) | |
setMethod ($method) | |
setParams (&$params) | |
setUrl ($url) | |
setUseProxySettings ($useProxySettings) | |
Data Fields | |
$_accept | |
$_async = false | |
$_headers = array() | |
$_method | |
$_params | |
$_url | |
$_useProxySettings = true | |
Represents a web service request.
Definition at line 17 of file WebServiceRequest.inc.php.
WebServiceRequest::__construct | ( | $url, | |
$params, | |||
$method = 'GET' , |
|||
$useProxy = true |
|||
) |
Constructor
$url | string The request URL |
$params | mixed array (key value pairs) or string request parameters |
$method | string GET or POST |
$useProxy | boolean Whether the proxy settings from config.inc.php should be considered |
Definition at line 68 of file WebServiceRequest.inc.php.
WebServiceRequest::getAccept | ( | ) |
Get the accept header value
Definition at line 139 of file WebServiceRequest.inc.php.
References $_accept.
WebServiceRequest::getAsync | ( | ) |
Whether to make an async request.
Definition at line 188 of file WebServiceRequest.inc.php.
References $_async.
WebServiceRequest::getHeaders | ( | ) |
Get additional request headers.
Definition at line 171 of file WebServiceRequest.inc.php.
References $_headers.
WebServiceRequest::getMethod | ( | ) |
Get the request method
Definition at line 115 of file WebServiceRequest.inc.php.
References $_method.
& WebServiceRequest::getParams | ( | ) |
Get the request parameters
Definition at line 99 of file WebServiceRequest.inc.php.
References $_params.
WebServiceRequest::getUrl | ( | ) |
Get the web service URL
Definition at line 83 of file WebServiceRequest.inc.php.
References $_url.
WebServiceRequest::getUseProxySettings | ( | ) |
Get whether to consider the proxy settings in config.inc.php.
Definition at line 204 of file WebServiceRequest.inc.php.
References $_useProxySettings.
WebServiceRequest::hasHeader | ( | $header | ) |
Check whether the given header is present in the request.
The check is case insensitive.
$header | string |
Definition at line 160 of file WebServiceRequest.inc.php.
WebServiceRequest::setAccept | ( | $accept | ) |
Set the accept header value
$accept | string |
Definition at line 131 of file WebServiceRequest.inc.php.
WebServiceRequest::setAsync | ( | $async | ) |
Set whether to make an async request. (POST requests only)
$async | boolean |
Definition at line 180 of file WebServiceRequest.inc.php.
WebServiceRequest::setHeader | ( | $header, | |
$content | |||
) |
Set an additional request header.
$header | string |
$content | string |
Definition at line 148 of file WebServiceRequest.inc.php.
WebServiceRequest::setMethod | ( | $method | ) |
Set the request method
$method | string |
Definition at line 123 of file WebServiceRequest.inc.php.
WebServiceRequest::setParams | ( | & | $params | ) |
Set the request parameters
$params | mixed array (key value pairs) or string |
Definition at line 107 of file WebServiceRequest.inc.php.
WebServiceRequest::setUrl | ( | $url | ) |
Set the web service URL
$url | string |
Definition at line 91 of file WebServiceRequest.inc.php.
WebServiceRequest::setUseProxySettings | ( | $useProxySettings | ) |
Set whether to consider the proxy settings in config.inc.php.
$useProxySettings | boolean |
Definition at line 196 of file WebServiceRequest.inc.php.
string WebServiceRequest::$_accept |
boolean WebServiceRequest::$_async = false |
Whether to make an asynchronous request
Definition at line 52 of file WebServiceRequest.inc.php.
Referenced by getAsync().
array WebServiceRequest::$_headers = array() |
Additional request headers
Definition at line 46 of file WebServiceRequest.inc.php.
Referenced by getHeaders().
string WebServiceRequest::$_method |
HTTP request method
Definition at line 34 of file WebServiceRequest.inc.php.
Referenced by getMethod().
mixed WebServiceRequest::$_params |
array (key value pairs) or string
Definition at line 28 of file WebServiceRequest.inc.php.
Referenced by getParams().
string WebServiceRequest::$_url |
Definition at line 22 of file WebServiceRequest.inc.php.
Referenced by getUrl().
boolean WebServiceRequest::$_useProxySettings = true |
Whether to consider the proxy settings in the config.inc.php
Definition at line 58 of file WebServiceRequest.inc.php.
Referenced by getUseProxySettings().