AfsPafLiveConnector Class Reference

AFS PaF Live connector. More...

Inheritance diagram for AfsPafLiveConnector:

Public Member Functions
	__construct ($host, AfsService $service, $paf_name, AfsAuthentication $authentication, $scheme=AFS_SCHEME_HTTP, SAI_CurlInterface $curlConnector=null)
	Construct new PaF Live connector.
	get_url ($context=null)
	Retrieves URL using additional parameters.
	get_http_headers ($context=null)
	Retrieves authentication as HTTP header for new authentication policy (>=v7.7)
	set_post_content (&$request, $context)
	Assigns new data to be sent through CURL request.
	process_doc ($doc, $layers=array("CONTENTS"))
	Upload one document to the PaF.
Public Member Functions inherited from AfsBOWSConnector
	__construct ($host, AfsService $service=null, $scheme=AFS_SCHEME_HTTP, SAI_CurlInterface $curlConnector=null)
	Constructs new Back Office Web Service connector.

Detailed Description

AFS PaF Live connector.

Constructor & Destructor Documentation

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

Construct new PaF Live connector.

Parameters

$host	[in] server hosting the Antidot Back Office.
$service	[in] antidot service (see AfsService).
$paf_name	[in] name of the PaF.
$authentication	[in-out] authentication object (see AfsAuthentication).
$scheme	[in] Scheme for the connection URL see Connection scheme (default: AFS_SCHEME_HTTP).

Exceptions

InvalidArgumentException

invalid scheme parameter provided.

Member Function Documentation

get_http_headers

(

$context = null

)

Retrieves authentication as HTTP header for new authentication policy (>=v7.7)

Parameters

$context

[in] Query context.

Returns

Appropriate HTTP header.

Reimplemented from AfsBOWSConnector.

get_url

(

$context = null

)

Retrieves URL using additional parameters.

Parameters

$context

[in] Query context.

Returns

Valid URL which can be queried using CURL.

Implements AfsBOWSConnectorInterface.

process_doc	(		$doc,
			$layers = array("CONTENTS")
	)

Upload one document to the PaF.

Parameters

$doc	[in] simple document (see AfsDocument).
$layers	[in] array containing names of layers to retrieve.

Returns

array of AfsLayers(see AfsLayer).

set_post_content	(	&	$request,
			$context
	)

Assigns new data to be sent through CURL request.

Parameters

$request	[in] Correctly initialized CURL request.
$context	[in] Query context.

Reimplemented from AfsBOWSConnector.