AfsSearch Class Reference

Facade for AFS search engine query. More...

Public Member Functions
	__construct ($host, $id, $status=AfsServiceStatus::STABLE, $curlConnector=null)
	Constructs AFS search facade.
Query coder
This coder is useful only when you want AFS helpers to generate appropriate links.
	set_query_coder (AfsQueryCoderInterface $query_coder)
	Defines new query coder.
	build_query_from_url_parameters ()
	Builds query using URL parameters.
Query management
Remember that AfsQuery objects are immutable.
	get_query ()
	Retrieves current query.
	set_query (AfsQuery $query)
	Defines new query.
	execute ($query=null, $format=AfsHelperFormat::HELPERS)
	Executes query.
	get_generated_url ()
	Retrieves URL used to query AFS search engine.
Miscellaneous accessors
	get_service ()
	Retrieves current AFS service.
	get_helpers_configuration ()
	Retrieves helper configuration.
	set_helper_configuration ($helperConfiguration)
	set helper configuration
	get_connector ()
	Retrieves search engine connector.

Detailed Description

Facade for AFS search engine query.

Examples:

full_lightweight_example.php, and raw_example.php.

Constructor & Destructor Documentation

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

Constructs AFS search 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

build_query_from_url_parameters

(

)

Builds query using URL parameters.

Use defined query coder or instanciate default query coder when none has yet been defined.

Returns

the built query.

execute	(		$query = null,
			$format = AfsHelperFormat::HELPERS
	)

Executes query.

Parameters

$query	[in]
$format	[in] prefered result format.

Returns

Helper or array depending on chosen $format.

get_connector

(

)

Retrieves search engine connector.

Returns

AFS search connector.

get_generated_url

(

)

Retrieves URL used to query AFS search engine.

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

Returns

generated URL for AFS search engine.

get_helpers_configuration

(

)

Retrieves helper configuration.

Returns

AFS Helper configuration.

get_query

(

)

Retrieves current query.

Returns

AFS search query.

get_service

(

)

Retrieves current AFS service.

Returns

AFS service.

set_helper_configuration

(

$helperConfiguration

)

set helper configuration

Parameters

$helperConfiguration

the new configuration

set_query

(

AfsQuery

$query

)

Defines new query.

Parameters

$query

[in] New query to set.

set_query_coder

(

AfsQueryCoderInterface

$query_coder

)

Defines new query coder.

Parameters

$query_coder

[in] query coder used to encode query into URL format and decode query from URL parameters.