AfsBaseReplysetHelper Class Reference

Base class for replyset helpers. More...

Inheritance diagram for AfsBaseReplysetHelper:

Public Member Functions
	__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.
	format ()
	Retrieves replyset as array.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

Base class for replyset helpers.

Constructor & Destructor Documentation

__construct	(		$reply_set,
		AfsHelperConfiguration	$config,
		AfsReplyHelperFactory	$factory
	)

Construct new replyset helper instance.

Parameters

$reply_set	[in] one reply from decoded json reply.
$config	[in] helper configuration object (see AfsHelperConfiguration).
$factory	[in] used to create appropriate reply helper.

Member Function Documentation

format

(

)

Retrieves 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.

Returns

array filled with key and values.

Reimplemented in AfsReplysetHelper.

get_meta

(

)

Retrieves meta data object.

Returns

instance of AfsMetaHelper.

get_nb_replies

(

)

Retrieve number of replies for current page.

you can retrieve total number of replies through get_meta()->get_total_items().

Returns

number of replies for current page.

get_replies

(

)

Retrieves all replies of current page.

You can loop on each reply:

foreach ($replies->get_replies() as $reply) {
  // Work on reply
}

Returns

All replies of current page.

has_reply

(

)

Checks whether reply set contains at least one reply.

Returns

true when one or more reply is defined, false otherwise.