Represents an AFS query. More...

Inheritance diagram for AfsQueryBase:

Public Member Functions
	__construct (AfsQueryBase $afs_query=null)
	Constructs new AFS ACP query object.
	get_parameters ($all=true)
	Retrieves query parameters.
	__get ($name)
	Add ability to get custom params as member fields.
Query management
	has_query ($feed=null)
	Checks whether current instance has a query.
	get_query ($feed=null)
	Retrieves the query.
	set_query ($new_query, $feed=null)
	Assigns new query value.
Number of replies management
	has_replies ($feed=null)
	Checks whether replies is set.
	set_replies ($replies_nb, $feed=null)
	Defines new number of replies.
	get_replies ($feed=null)
	Get number of replies per page.
Origin of the query
	auto_set_from ($auto_set=true)
	Defines whether `from` parameter should be auto set when possible.
	set_from ($from, $feed=null)
	Defines the origin of the query.
	get_from ($feed=null)
	Retrieves origin of the query.
User and session identifier.
These identifiers are used to uniquely identify a user and a corresponding session.
	set_user_id ($user_id)
	Defines user id.
	has_user_id ()
	Checks whether user id is set.
	get_user_id ()
	Retrieves user identifier.
	set_session_id ($session_id)
	Defines session id.
	has_session_id ()
	Checks whether session id is set.
	get_session_id ()
	Retrieves session id.
	initialize_user_and_session_id (AfsUserSessionManager $mgr)
	Initializes user id and session id.
	update_user_and_session_id ($user_id, $session_id)
	Updates user and session identifiers.
Logging
	add_log ($value)
	Adds new logging information.
	get_logs ()
	Retrieves current defined logs.
Key management
	has_key ($feed=null)
	Checks whether key parameter is set.
	set_key ($key_id, $feed=null)
	Defines key id.
	get_key ($feed=null)
	Retrieves key value.

Protected Member Functions
	on_assignment ()
	Action to perform when an assignment occurs.
	get_relevant_parameters ()
	Retrieves relevant parameters.
	get_additional_parameters ()
	Retrieves additional parameters.

Feed management
	has_feed ($feed=null)
	Checks whether feed parameter is set.
	set_feed ($feed)
	Assigns new feed name replacing any existing one.
	add_feed ($feed)
	Assigns new feed name.
	get_feeds ()
	Retrieves all defined feeds.
	get_feed ($feed)

Detailed Description

Represents an AFS query.

Derived class of this one:

must implement copy method: so that AfsQueryXXX objects can be immutable.
should reimplement on_assignment method: to trigger specific actions when an assignment occurs.

Constructor & Destructor Documentation

__construct ( AfsQueryBase $afs_query = null )

Constructs new AFS ACP query object.

Parameters

$afs_query [in] instance used for initialization (defaul: create new empty instance).

Member Function Documentation

add_feed ( $feed )

Assigns new feed name.

Parameters

$feed [in] new feed to filter on.

add_log ( $value )

Adds new logging information.

This can be used to log your system version or anything else. Version of this API is appended to this list of values.

Remarks: Page value is preserved when this method is called.

Parameters

$value [in] appended value.

auto_set_from ( $auto_set = true )

Defines whether from parameter should be auto set when possible.

Parameters

$auto_set [in] auto set status (default = true).

Returns: copy of the query with appropriate auto set parameter.

get_additional_parameters ( )

protected

Retrieves additional parameters.

Derived class should override this method with only its own parameters.

Returns: class specific additional parameters.

Reimplemented in AfsQuery.

get_feeds ( )

Retrieves all defined feeds.

Returns: defined feeds in array or null when no feed is defined.

get_from ( $feed = null )

Retrieves origin of the query.

Returns: origin of the query.

get_key ( $feed = null )

Retrieves key value.

Returns: Key value.

get_logs ( )

Retrieves current defined logs.

Main purpose of this method is debugging purpose.

Returns: defined logs.

get_parameters ( $all = true )

Retrieves query parameters.

Retrieves all or relevant parameters. For example, from parameter is not relevant except for AFS search engine. So, this parameter is not retrieved when all is set to false.

Parameters

$all	[in] if set to `true`, all parameters are retrieved, otherwise only relevent parameters are retrieved.

Returns: array of all defined query parameters.

get_query ( $feed = null )

Retrieves the query.

You should have previously tested whether the instance has a defined query by calling has_query.

Returns: the query.

get_relevant_parameters ( )

protected

Retrieves relevant parameters.

Derived class should override this method with only its own parameters.

Returns: class specific relevant parameters.

Reimplemented in AfsQuery.

get_replies ( $feed = null )

Get number of replies per page.

Returns: number of replies per reply page.

get_session_id ( )

Retrieves session id.

Returns: the session id or null if unset.

get_user_id ( )

Retrieves user identifier.

Returns: user identifier or null if unset.

has_feed ( $feed = null )

Checks whether feed parameter is set.

Returns: true when at least one feed is defined, false otherwise.

has_key ( $feed = null )

Checks whether key parameter is set.

Returns: True when key parameter is set, false otherwise.

has_query ( $feed = null )

Checks whether current instance has a query.

Returns: true when a query is defined, false otherwise.

has_replies ( $feed = null )

Checks whether replies is set.

Returns: always true.

has_session_id ( )

Checks whether session id is set.

Deprecated:: This method always return true and will be removed soon.

Returns: True when session id is set, false otherwise.

has_user_id ( )

Checks whether user id is set.

Deprecated:: This method always return true and will be removed soon.

Returns: True when user id is set, false otherwise.

initialize_user_and_session_id ( AfsUserSessionManager $mgr )

Initializes user id and session id.

These identifiers are initialized thanks to specific manager. Refers to AfsUserSessionManager for more details. User and session identifiers are updated with identifiers from AfsUserSessionManager when they are available. Otherwise, query identifiers are not modified.

Parameters

$mgr	[in] Instance of AfsUserSessionManager.

Returns: current instance.

on_assignment ( )

protected

Action to perform when an assignment occurs.

Nothing is done unless this method is overloaded in child classes.

Reimplemented in AfsQuery.

set_feed ( $feed )

Assigns new feed name replacing any existing one.

Parameters

$feed [in] new feed to filter on.

set_from	(	$from,
		$feed = `null`
	)

Defines the origin of the query.

Remarks: on_assignment method is not called by this method.

Parameters

$from [in] origin of the query. It should be a value defined by AfsOrigin.

Returns: current instance.

Exceptions

Exception when provided origin value is invalid.

set_key	(	$key_id,
		$feed = `null`
	)

Defines key id.

Parameters

$key_id [in] Key id to set.

Returns: Current instance.

set_query	(	$new_query,
		$feed = `null`
	)

Assigns new query value.

Any previously defined query is replaced by the provided one.

Parameters

$new_query [in] query to assign to the instance.

Returns: new up to date instance.

set_replies	(	$replies_nb,
		$feed = `null`
	)

Defines new number of replies.

Parameters

$replies_nb [in] requested number of replies. It should be greater than or equal to 1.

Returns: new up to date instance.

Exceptions

Exception on invalid replies number provided.

set_session_id ( $session_id )

Defines session id.

Remarks: Page value is preserved when this method is called.

Parameters

$session_id [in] Session id to set.

Returns: current instance.

set_user_id ( $user_id )

Defines user id.

Remarks: Page value is preserved when this method is called.

Parameters

$user_id [in] User id to set.

Returns: current instance.

update_user_and_session_id	(	$user_id,
		$session_id
	)

Updates user and session identifiers.

Deprecated:: Nothing happens since identifiers are always initialized.

These identifiers are updated only if they are not yet defined.

Remarks: Page value is preserved when this method is called.

Parameters

$user_id	[in] user id to set.
$session_id	[in] session id to set.

Returns: current instance.

Public Member Functions

Protected Member Functions

Feed management

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation