AfsAcpQuery Class Reference

Represents an AFS ACP query. More...

Inheritance diagram for AfsAcpQuery:

Additional Inherited Members
Public Member Functions inherited from AfsQueryBase
	__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.
	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.
	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.
	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.
	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.
	add_log ($value)
	Adds new logging information.
	get_logs ()
	Retrieves current defined logs.
	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.
	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.
Protected Member Functions inherited from AfsQueryBase
	on_assignment ()
	Action to perform when an assignment occurs.
	get_relevant_parameters ()
	Retrieves relevant parameters.
	get_additional_parameters ()
	Retrieves additional parameters.
	get_feed ($feed)

Detailed Description

Represents an AFS ACP query.

All instances of this class are immutable: most of all call involves creation of new instance copied from current one. Newly created instance is modified according to called method and then returned. So, don't forget to store returned object!