AfsReplysetHelper Class Reference

Helper for replies from one feed. More...

Inheritance diagram for AfsReplysetHelper:

Public Member Functions
	__construct ($reply_set, AfsQuery $query, AfsHelperConfiguration $config)
	Construct new replyset helper instance.
	has_facet ()
	Check whether facets are defined.
	get_facets ()
	List of facets.
	has_cluster ()
	Check whether clusters are defined.
	get_clusters ()
	Retrieves all cluster replies.
	get_cluster_replies ()
	Retrieves replies from all clusters.
	get_all_replies ()
	Retrieves replies from all clusters and overspill replies.
	has_pager ()
	Checks whether pager is defined.
	get_pager ()
	Retrieves pager object.
	format ()
	Retrieve replyset as array.
Public Member Functions inherited from AfsBaseReplysetHelper
	__construct ($reply_set, AfsHelperConfiguration $config, AfsReplyHelperFactory $factory)
	Construct new replyset helper instance.
	get_meta ()
	Retrieves meta data object.
	has_reply ()
	Checks whether reply set contains at least one reply.
	get_nb_replies ()
	Retrieve number of replies for current page.
	get_replies ()
	Retrieves all replies of current page.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

Helper for replies from one feed.

This helper gives access to underlying helpers for metadata, replies, factes and pager.

Constructor & Destructor Documentation

__construct	(		$reply_set,
		AfsQuery	$query,
		AfsHelperConfiguration	$config
	)

Construct new replyset helper instance.

Parameters

$reply_set	[in] one reply from decoded json reply.
$query	[in] query which has produced current reply.
$config	[in] helper configuration object.

Member Function Documentation

format

(

)

Retrieve replyset as array.

All data are store in key => value format:

• meta: array of meta data (AfsMetaHelper::format),
• nb_replies: number of replies on the current page.
• replies: standard or Promote reply.
• facets: array of facets (AfsFacetHelper::format),
• pager: array of pages (AfsPagerHelper::format),

Returns

array filled with key and values.

Reimplemented from AfsBaseReplysetHelper.

get_all_replies

(

)

Retrieves replies from all clusters and overspill replies.

Replies from all clusters are merged with overspill replies. This is a shortcut for a call of both following methods: AfsReplysetHelper::get_cluster_replies and AfsReplysetHelper::get_replies.

Returns

merged replies.

get_cluster_replies

(

)

Retrieves replies from all clusters.

Replies from all cluster are merged preserving cluster result order.

Returns

Merged replies from all clusters.

get_clusters

(

)

Retrieves all cluster replies.

Returns

cluster replies.

get_facets

(

)

List of facets.

Returns

facets.

get_pager

(

)

Retrieves pager object.

Returns

instance of AfsPagerHelper.

has_cluster

(

)

Check whether clusters are defined.

Returns

True when at least one cluster is defined, false otherwise.

has_facet

(

)

Check whether facets are defined.

Returns

True when at least one facet is defined, false otherwise.

has_pager

(

)

Checks whether pager is defined.

Returns

True when pager exists, false otherwise.