AfsBaseReplyHelper Class Reference

Base class for reply helpers. More...

Inheritance diagram for AfsBaseReplyHelper:

Public Member Functions
	__construct ($reply, AfsTextVisitorInterface $visitor)
	Constructs new instance.
	get_title ()
	Retrieves formatted title reply.
	get_abstract ()
	Retrieves formatted abstract reply.
	get_uri ()
	Retrieves URI of the document.
	format ()
	Retrieves reply data as array.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

Base class for reply helpers.

Constructor & Destructor Documentation

__construct	(		$reply,
		AfsTextVisitorInterface	$visitor
	)

Constructs new instance.

Parameters

$reply	[in] should correspond to one reply.
$visitor	[in] visitor used to traverse title and abstract reply texts.

Reimplemented in AfsReplyHelper.

Member Function Documentation

format

(

)

Retrieves reply data as array.

All data are store in key => value format:

• title: title of the reply,
• abstract: abstract of the reply,
• uri: URI of the reply.

Returns

array filled with key and values.

get_abstract

(

)

Retrieves formatted abstract reply.

Returns

abstract reply or empty string if not defined.

get_title

(

)

Retrieves formatted title reply.

Returns

title reply or empty string if not defined.

get_uri

(

)

Retrieves URI of the document.

Returns

document URI or empty string if not set.