AfsClientDataHelperInterface Interface Reference

Client data interface. More...

Inheritance diagram for AfsClientDataHelperInterface:

Public Member Functions
	get_value ($name=null, $context=array(), $formatter=null)
	Retrieves client data as text.
	get_values ($name=null, $context=array(), $formatter=null)
	Retrieves client data as array of texts.
	get_node ($name=null, $context=array())
	Retrieves full client data node (value and attributes)
	get_nodes ($name=null, $context=array())
	Retrieves full client data nodes (value and attributes)
	get_mime_type ()
	Retrieve client data's mime type.

Detailed Description

Client data interface.

Member Function Documentation

get_mime_type

(

)

Retrieve client data's mime type.

Returns

mime type of the client data.

Implemented in AfsJsonClientDataHelper, and AfsXmlClientDataHelper.

get_node	(		$name = null,
			$context = array()
	)

Retrieves full client data node (value and attributes)

Parameters

$name	[in] node name to be extracted
$context	[in] context used for looking for node with specified name.

Returns

first occurrence of node as array

Implemented in AfsJsonClientDataHelper, and AfsXmlClientDataHelper.

get_nodes	(		$name = null,
			$context = array()
	)

Retrieves full client data nodes (value and attributes)

Parameters

$name	[in] node name to be extracted
$context	[in] context used for looking for node with specified name.

Returns

all occurrences as array

Implemented in AfsJsonClientDataHelper, and AfsXmlClientDataHelper.

get_value	(		$name = null,
			$context = array(),
			$formatter = null
	)

Retrieves client data as text.

All client data or sub-tree can be retrieved depending on name parameter.

Parameters

$name	[in] data name to be extracted (default=null, retrieve all client data).
$context	[in] context used for looking for text with specified name.
$formatter	[in] format output string. It is used when highlight in client data is activated. See implementation to provide appropriate formatter (default=null, default formatter is used).

Returns

first matching client data with specified name as text.

Implemented in AfsJsonClientDataHelper, and AfsXmlClientDataHelper.

get_values	(		$name = null,
			$context = array(),
			$formatter = null
	)

Retrieves client data as array of texts.

All client data or sub-tree can be retrieved depending on name parameter.

Parameters

$name	[in] data name to be extracted (default=null, retrieve all client data).
$context	[in] context used for looking for text with specified name.
$formatter	[in] format output string. It is used when highlight in client data is activated. See implementation to provide appropriate formatter (default=null, default formatter is used).

Returns

matching client data as array of texts.

Implemented in AfsJsonClientDataHelper, and AfsXmlClientDataHelper.