WebServiceQuerier Class Reference [Framework for the Web Services]

Query a RESTFul web service endpoint. More...

Public Member Functions
	__construct ($url, $method, $mime, $parameters, $timeout=0)
	Constructor.
	__destruct ()
	queryWebService ()
	Send a query to a web service endpoint.
	getStatus ()
	Get the status of the query.
	getStatusMessage ()
	Get the message of the status of the query.
	getStatusMessageDescription ()
	Get the extended message of the status of the query.
	getResultset ()
	Get the resultset of a query.
Data Fields
	$error
	Internal error of the queried web service. The error doesn't necessarly come from the queried web service endpoint in the case of a compound web service.
Private Attributes
	$url
	URL of the web service endpoint to query.
	$method
	HTTP method to use to query the endpoint (GET or POST).
	$parameters
	Parameters to send to the endpoint.
	$mime
	Mime type of the resultset that has to be returned by the web service endpoint.
	$queryStatus = ""
	Status of the query.
	$queryStatusMessage = ""
	Status message of the query.
	$queryStatusMessageDescription = ""
	Extended message of the status of the query.
	$queryResultset = ""
	Resultset of the query.
	$errorId = ""
	Internal error ID of the queried web sevice.
	$errorName = ""
	Internal error name of the queried web sevice.
	$errorDescription = ""
	Internal error description of the queried web sevice.
	$errorDebugInfo = ""
	Internal error debug information of the queried web sevice.

---

Detailed Description

Query a RESTFul web service endpoint.

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 27 of file WebServiceQuerier.php.

---

Constructor & Destructor Documentation

__construct	(	$	url,
		$	method,
		$	mime,
		$	parameters,
		$	timeout = 0
	)

Constructor.

Parameters:

[in]	$url	URL of the web service endpoint to query
[in]	$method	HTTP method to use to query the endpoint (GET or POST)
[in]	$mime	Mime type of the resultset that has to be returned by the web service endpoint
[in]	$parameters	Parameters to send to the endpoint
[in]	$timeout	Timeout (in milliseconds) before ending the query to a remote web service.

Returns:

returns returns a human readable description of the class

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 87 of file WebServiceQuerier.php.

References $method, $mime, $parameters, $url, and queryWebService().

Here is the call graph for this function:

__destruct

(

)

Definition at line 98 of file WebServiceQuerier.php.

---

Member Function Documentation

getResultset

(

)

Get the resultset of a query.

Returns:

returns the resultset of a query

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 343 of file WebServiceQuerier.php.

getStatus

(

)

Get the status of the query.

Returns:

returns the status of the query

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 298 of file WebServiceQuerier.php.

getStatusMessage

(

)

Get the message of the status of the query.

Returns:

returns the message of the status of the query

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 313 of file WebServiceQuerier.php.

getStatusMessageDescription

(

)

Get the extended message of the status of the query.

Returns:

returns the extended message of the status of the query

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 328 of file WebServiceQuerier.php.

queryWebService

(

)

Send a query to a web service endpoint.

Author:

Frederick Giasson, Structured Dynamics LLC.

Definition at line 108 of file WebServiceQuerier.php.

References $errorDebugInfo, $errorDescription, $errorId, and $errorName.

Referenced by __construct().

---

Field Documentation

$error

Internal error of the queried web service. The error doesn't necessarly come from the queried web service endpoint in the case of a compound web service.

Definition at line 69 of file WebServiceQuerier.php.

$errorDebugInfo = "" [private]

Internal error debug information of the queried web sevice.

Definition at line 64 of file WebServiceQuerier.php.

Referenced by queryWebService().

$errorDescription = "" [private]

Internal error description of the queried web sevice.

Definition at line 61 of file WebServiceQuerier.php.

Referenced by queryWebService().

$errorId = "" [private]

Internal error ID of the queried web sevice.

Definition at line 55 of file WebServiceQuerier.php.

Referenced by queryWebService().

$errorName = "" [private]

Internal error name of the queried web sevice.

Definition at line 58 of file WebServiceQuerier.php.

Referenced by queryWebService().

$method [private]

HTTP method to use to query the endpoint (GET or POST).

Definition at line 33 of file WebServiceQuerier.php.

Referenced by __construct().

$mime [private]

Mime type of the resultset that has to be returned by the web service endpoint.

Definition at line 39 of file WebServiceQuerier.php.

Referenced by __construct().

$parameters [private]

Parameters to send to the endpoint.

Definition at line 36 of file WebServiceQuerier.php.

Referenced by __construct().

$queryResultset = "" [private]

Resultset of the query.

Definition at line 52 of file WebServiceQuerier.php.

$queryStatus = "" [private]

Status of the query.

Definition at line 42 of file WebServiceQuerier.php.

$queryStatusMessage = "" [private]

Status message of the query.

Definition at line 45 of file WebServiceQuerier.php.

$queryStatusMessageDescription = "" [private]

Extended message of the status of the query.

Definition at line 48 of file WebServiceQuerier.php.

$url [private]

URL of the web service endpoint to query.

Definition at line 30 of file WebServiceQuerier.php.

Referenced by __construct().

---

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

• WebServiceQuerier.php