AfsAcp Class Reference

Facade for AFS ACP engine query. More...

Public Member Functions
	__construct ($host, $id, $status=AfsServiceStatus::STABLE)
	Constructs AFS ACP facade.
Query management
Remember that AfsAcpQuery objects are immutable.
	query ($value, $feeds=array())
	Defines query string for ACP engine.
	get_query ()
	Retrieves current query.
	set_query (AfsAcpQuery $query)
	Defines new query.
	execute ($format=AfsHelperFormat::ARRAYS)
	Executes query.
	get_generated_url ()
	Retrieves URL used to query AFS ACP engine.
Miscellaneous accessors
	get_service ()
	Retrieves current AFS service.
	get_helpers_configuration ()
	Retrieves helper configuration.
	get_connector ()
	Retrieves ACP engine connector.

Detailed Description

Facade for AFS ACP engine query.

Examples:

acp_helper_example.php.

Constructor & Destructor Documentation

__construct	(		$host,
			$id,
			$status = AfsServiceStatus::STABLE
	)

Constructs AFS ACP facade.

Parameters

$host	[in] server hosting the required service.
$id	[in] identifier of the desired service.
$status	[in] status of the desired service (see AfsServiceStatus).

Member Function Documentation

execute

(

$format = AfsHelperFormat::ARRAYS

)

Executes query.

Parameters

$format

[in] prefered result format.

Returns

Helper or array depending on chosen $format.

get_connector

(

)

Retrieves ACP engine connector.

Returns

AFS ACP connector.

get_generated_url

(

)

Retrieves URL used to query AFS ACP engine.

Useful for debug purpose only. It should be called after AfsAcp::execute has been called.

Returns

generated URL for AFS ACP engine.

get_helpers_configuration

(

)

Retrieves helper configuration.

Returns

AFS Helper configuration.

get_query

(

)

Retrieves current query.

Returns

AFS ACP query.

get_service

(

)

Retrieves current AFS service.

Returns

AFS service.

query	(		$value,
			$feeds = array()
	)

Defines query string for ACP engine.

This is a shortcut to:

 $query = $acp->get_query();
$query = $query->set_query($value)->set_feed('value1')->add_feed('value2');
$acp->set_query($query); 

This can be writtent in onle line as following:

$acp->query($value, array('value1', 'value2')); 

Parameters

$value	[in] New value to submit to ACP engine.
$feeds	[in] List of feeds to filter on. By default, there is no filter on feeds (empty array).

set_query

(

AfsAcpQuery

$query

)

Defines new query.

Parameters

$query

[in] New query to set.