Service Class Reference

Class to implement a service. More...

Inheritance diagram for Service:

Public Member Functions
	__construct ($consumer, $endpoint, $mediaType)
	Class constructor. More...
	send ($method, $parameters=array(), $body=null)
	Send a service request. More...
	getHTTPMessage ()
	Get HTTPMessage object for last request. More...

Data Fields
	$unsigned = false
	Whether service request should be sent unsigned. More...

Protected Attributes
	$endpoint
	Service endpoint. More...

Detailed Description

Class to implement a service.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

Version

3.1.0

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 17 of file Service.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$consumer,
			$endpoint,
			$mediaType
	)

Class constructor.

Parameters

ToolConsumer	$consumer	Tool consumer object for this service request
string	$endpoint	Service endpoint
string	$mediaType	Media type of message body

Definition at line 62 of file Service.php.

References Service\$endpoint.

Member Function Documentation

getHTTPMessage()

getHTTPMessage

(

)

Get HTTPMessage object for last request.

Returns

HTTPMessage HTTP object containing request and response details

Definition at line 114 of file Service.php.

send()

send	(		$method,
			$parameters = array(),
			$body = null
	)

Send a service request.

Parameters

string	$method	The action type constant (optional, default is GET)
array	$parameters	Query parameters to add to endpoint (optional, default is none)
string	$body	Body of request (optional, default is null)

Returns

HTTPMessage HTTP object containing request and response details

Definition at line 78 of file Service.php.

References Service\$endpoint.

Referenced by Membership\get(), and ToolSettings\get().

Field Documentation

$endpoint

string $endpoint

protected

Service endpoint.

Definition at line 32 of file Service.php.

Referenced by Membership\__construct(), Service\__construct(), ToolSettings\__construct(), and Service\send().

$unsigned

bool $unsigned = false

Whether service request should be sent unsigned.

Definition at line 25 of file Service.php.

---

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

• Service.php