AFS ACP Replyset helper. More...

Inheritance diagram for AfsAcpReplysetHelper:

Public Member Functions
	__construct ($name, $reply_set, AfsAcpConfiguration $config=null)
	Constructs new ACP replyset helper.
	get_feed ()
	Retrieves name of the feed which has produced these suggestions.
	get_query_string ()
	Retrieves query string.
Suggestions
	has_reply ()
	Checks wether at least one reply is available.
	get_nb_replies ()
	Retrieves number suggestions.
	get_replies ()
	Retrieves suggestions.
Miscellaneous
	format ()
	Retrieves suggestions as array.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

AFS ACP Replyset helper.

Each replyset corresponds to suggestions of each feed.

Constructor & Destructor Documentation

Constructs new ACP replyset helper.

Parameters

$name	[in] Feed name source of generated suggestions.
$reply_set	[in] Json decoded suggestions of specific replyset.
$config	ACP configuration.

Exceptions

AfsAcpEmptyReplysetException	when feed does not generate any suggestion.
AfsAcpUnmanagedSuggestionFormatException	when provided $reply_set format is unknown.
AfsAcpInvalidSuggestionFormatException	when provided $reply_set is invalid.

format ( )

Retrieves suggestions as array.

This method is intended for internal use only.

All suggestions are stored in list format.

get_feed ( )

Retrieves name of the feed which has produced these suggestions.

get_nb_replies ( )

Retrieves number suggestions.

get_query_string ( )

Retrieves query string.

get_replies ( )

Retrieves suggestions.

has_reply ( )

Checks wether at least one reply is available.