eZMatrixType Class Reference

The class eZMatrixType does. More...

Inheritance diagram for eZMatrixType:

Collaboration diagram for eZMatrixType:

List of all members.

Public Member Functions
	batchInitializeObjectAttributeData ($classAttribute)
	classAttributeContent ($contentClassAttribute)
	customClassAttributeHTTPAction ($http, $action, $contentClassAttribute)
	customObjectAttributeHTTPAction ($http, $action, $contentObjectAttribute, $parameters)
	eZMatrixType ()
	fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	fromString ($contentObjectAttribute, $string)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	isIndexable ()
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	preStoreClassAttribute ($classAttribute, $version)
	serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	serializeContentObjectAttribute ($package, $objectAttribute)
	storeClassAttribute ($contentClassAttribute, $version)
	storeObjectAttribute ($contentObjectAttribute)
	supportsBatchInitializeObjectAttribute ()
	title ($contentObjectAttribute, $name= 'name')
	toString ($contentObjectAttribute)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	CELL_VARIABLE = '_ezmatrix_cell_'
const	DATA_TYPE_STRING = 'ezmatrix'
const	DEFAULT_NAME_VARIABLE = '_ezmatrix_default_name_'
const	NUM_COLUMNS_VARIABLE = '_ezmatrix_default_num_columns_'
const	NUM_ROWS_VARIABLE = '_ezmatrix_default_num_rows_'

---

Detailed Description

The class eZMatrixType does.

Definition at line 18 of file ezmatrixtype.php.

---

Member Function Documentation

eZMatrixType::batchInitializeObjectAttributeData

(

$

classAttribute

)

Reimplemented from eZDataType.

Definition at line 510 of file ezmatrixtype.php.

eZMatrixType::classAttributeContent

(

$

contentClassAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 345 of file ezmatrixtype.php.

eZMatrixType::customClassAttributeHTTPAction	(	$	http,
		$	action,
		$	classAttribute
	)

Executes a custom action for a class attribute which was defined on the web page.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 352 of file ezmatrixtype.php.

eZMatrixType::customObjectAttributeHTTPAction	(	$	http,
		$	action,
		$	objectAttribute,
		$	parameters
	)

Executes a custom action for an object attribute which was defined on the web page.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 149 of file ezmatrixtype.php.

eZMatrixType::eZMatrixType

(

)

Constructor

Definition at line 30 of file ezmatrixtype.php.

eZMatrixType::fetchClassAttributeHTTPInput	(	$	http,
		$	base,
		$	classAttribute
	)

Fetches the HTTP input for the content class attribute.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 246 of file ezmatrixtype.php.

eZMatrixType::fetchObjectAttributeHTTPInput	(	$	http,
		$	base,
		$	contentObjectAttribute
	)

Fetches the http post var matrix cells input and stores it in the data instance.

Reimplemented from eZDataType.

Definition at line 129 of file ezmatrixtype.php.

eZMatrixType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 407 of file ezmatrixtype.php.

eZMatrixType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

true if the datatype finds any content in the attribute $contentObjectAttribute.

Reimplemented from eZDataType.

Definition at line 92 of file ezmatrixtype.php.

eZMatrixType::initializeObjectAttribute	(	$	contentObjectAttribute,
		$	currentVersion,
		$	originalContentObjectAttribute
	)

Sets the default value.

Reimplemented from eZDataType.

Definition at line 220 of file ezmatrixtype.php.

eZMatrixType::isIndexable

(

)

Returns:

true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 383 of file ezmatrixtype.php.

eZMatrixType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 108 of file ezmatrixtype.php.

eZMatrixType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 83 of file ezmatrixtype.php.

eZMatrixType::preStoreClassAttribute	(	$	classAttribute,
		$	version
	)

Similar to the storeClassAttribute but is called before the attribute itself is stored and can be used to set values in the class attribute.

Returns:

True if the value was stored correctly.

See also:

fetchClassAttributeHTTPInput

Reimplemented from eZDataType.

Definition at line 336 of file ezmatrixtype.php.

eZMatrixType::serializeContentClassAttribute	(	$	classAttribute,
		$	attributeNode,
		$	attributeParametersNode
	)

Adds the necessary dom structure to the attribute parameters.

Note:

The default is to add unsupported='true' to the attribute node, meaning that the datatype does not support serializing.

Reimplemented from eZDataType.

Definition at line 436 of file ezmatrixtype.php.

eZMatrixType::serializeContentObjectAttribute	(	$	package,
		$	objectAttribute
	)

Parameters:

package
objectAttribute	content attribute

Returns:

a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 485 of file ezmatrixtype.php.

eZMatrixType::storeClassAttribute	(	$	classAttribute,
		$	version
	)

Stores the datatype data to the database which is related to the class attribute. The $version parameter determines which version is currently being stored, 0 is the real version while 1 is the temporary version.

Returns:

True if the value was stored correctly.

Note:

The method is entirely up to the datatype, for instance it could reuse the available types in the the attribute or store in a separate object.

This function is called after the attribute data has been stored. If you need to alter attribute data use preStoreClassAttribute instead.

See also:

fetchClassAttributeHTTPInput

Reimplemented from eZDataType.

Definition at line 72 of file ezmatrixtype.php.

eZMatrixType::storeObjectAttribute

(

$

contentObjectAttribute

)

Store content

Reimplemented from eZDataType.

Definition at line 64 of file ezmatrixtype.php.

eZMatrixType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 505 of file ezmatrixtype.php.

eZMatrixType::title	(	$	contentObjectAttribute,
		$	name = 'name'
	)

Returns the integer value.

Reimplemented from eZDataType.

Definition at line 208 of file ezmatrixtype.php.

eZMatrixType::toString

(

$

contentObjectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 392 of file ezmatrixtype.php.

eZMatrixType::unserializeContentClassAttribute	(	$	classAttribute,
		$	attributeNode,
		$	attributeParametersNode
	)

Extracts values from the attribute parameters and sets it in the class attribute.

Note:

This function is called after the attribute has been stored and a second store is called after this function is done.

Reimplemented from eZDataType.

Definition at line 466 of file ezmatrixtype.php.

eZMatrixType::unserializeContentObjectAttribute	(	$	package,
		$	objectAttribute,
		$	attributeNode
	)

Unserialize contentobject attribute

Parameters:

package
objectAttribute	contentobject attribute object
attributeNode	ezdomnode object

Reimplemented from eZDataType.

Definition at line 498 of file ezmatrixtype.php.

eZMatrixType::validateObjectAttributeHTTPInput	(	$	http,
		$	base,
		$	contentObjectAttribute
	)

Validates the input and returns true if the input was valid for this datatype.

Reimplemented from eZDataType.

Definition at line 40 of file ezmatrixtype.php.

---

Member Data Documentation

const eZMatrixType::CELL_VARIABLE = '_ezmatrix_cell_'

Definition at line 24 of file ezmatrixtype.php.

const eZMatrixType::DATA_TYPE_STRING = 'ezmatrix'

Definition at line 25 of file ezmatrixtype.php.

const eZMatrixType::DEFAULT_NAME_VARIABLE = '_ezmatrix_default_name_'

Definition at line 20 of file ezmatrixtype.php.

const eZMatrixType::NUM_COLUMNS_VARIABLE = '_ezmatrix_default_num_columns_'

Definition at line 22 of file ezmatrixtype.php.

const eZMatrixType::NUM_ROWS_VARIABLE = '_ezmatrix_default_num_rows_'

Definition at line 23 of file ezmatrixtype.php.

---

The documentation for this class was generated from the following file:

• ezmatrixtype.php