AfsAboutConnector Class Reference

Simple connector to retrieve AFS Back Office information. More...

Inheritance diagram for AfsAboutConnector:

Public Member Functions
	__construct ($host, AfsService $service=null, $scheme=AFS_SCHEME_HTTP, SAI_CurlInterface $curlConnector=null)
	Constructs new Back Office Web Service connector.
	get_url ($context=null)
	Retrieves URL.
	get_information ()
	Retrieves AFS Back Office Web Services information.
Public Member Functions inherited from AfsBOWSConnector
	get_http_headers ($context=null)
	Default implementation: do nothing.
	set_post_content (&$request, $context)
	Default implementation: do nothing.
Public Member Functions inherited from AfsBOWSConnectorInterface
	get_http_headers ($context=null)
	Retrieves additional HTTP headers to set.
	set_post_content (&$request, $context)
	Assigns new data to be sent through CURL request.

Detailed Description

Simple connector to retrieve AFS Back Office information.

Constructor & Destructor Documentation

__construct	(		$host,
		AfsService	$service = null,
			$scheme = AFS_SCHEME_HTTP,
		SAI_CurlInterface	$curlConnector = null
	)

Constructs new Back Office Web Service connector.

Parameters

$host	[in] server hosting the Antidot Back Office.
$service	[in] Antidot service (see AfsService).
$scheme	[in] Scheme for the connection URL see Connection scheme (default: AFS_SCHEME_HTTP).
$curlConnector	[in] Connector to curl, useful for mocking curl calls

Exceptions

InvalidArgumentException

invalid scheme parameter provided.

Reimplemented from AfsBOWSConnector.

Member Function Documentation

get_information

(

)

Retrieves AFS Back Office Web Services information.

This trigger a query to the host hosting AFS Back Office.

Returns

AfsBOWSInformation object.

get_url

(

$context = null

)

Retrieves URL.

Parameters

$context

[in] Unused parameter.

Returns

Valid URL to query information about installed AFS Back Office.

Implements AfsBOWSConnectorInterface.