AfsQueryCoderInterface Interface Reference

Interface for encoding/decoding queries. More...

Inheritance diagram for AfsQueryCoderInterface:

Public Member Functions
	generate_parameters (AfsQuery $query)
	Generate suitable parameters which can be used in URL.
	generate_link (AfsQuery $query)
	Convenient method to build link.
	build_query (array $params)
	Generate query object from array of parameters.

Detailed Description

Interface for encoding/decoding queries.

Encoded query is used to generate parameters suitable to build link for specific action.
Query is decoded from array of parameters. This array usually comes from $_GET value.

For example:

• Suppose you are looking for shoes in your favorite web store.
• First you search for the word shoes.
• Then some results are presented along with size and color facets.
• Now you want to filter on red color.
• You have to build the query object from URL parameters, otherwise if you filter on the color only, you will get all red items. So you should initialize your query with:

  $query = $query_coder->build_query($_GET);

• Now you want to filter on red color, you have to add a filter to the query:

  $query = $query->add_filter('color', 'red'); 

• Then you can generate parameters suitable for a valid HTTP link by calling:

  $params = $query_coder->generate_parameters($query); 

  .

Member Function Documentation

build_query

(

array

$params

)

Generate query object from array of parameters.

Parameters

$params

[in] array of parameters used to build query object.

Returns

properly initialized query object.

Implemented in AfsQueryCoder.

generate_link

(

AfsQuery

$query

)

Convenient method to build link.

This method generally calls generate_parameters to build appropriate link.

Parameters

$query

[in] AfsQuery used to generate appropriate link.

Returns

link which can be directly used to query AFS search engine.

Implemented in AfsQueryCoder.

generate_parameters

(

AfsQuery

$query

)

Generate suitable parameters which can be used in URL.

Parameters

$query

[in] query object to encode.

Returns

encoded query object.

Implemented in AfsQueryCoder.