The class eZIdentifierType does. More...

Inheritance diagram for eZIdentifierType:

Collaboration diagram for eZIdentifierType:

Public Member Functions
	customClassAttributeHTTPAction ($http, $action, $contentClassAttribute)
	eZIdentifierType ()
	fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	fromString ($contentObjectAttribute, $string)
	generateIdentifierString ($contentClassAttribute, $identifierValue=false)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeClassAttribute ($classAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	isIndexable ()
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	onPublish ($contentObjectAttribute, $contentObject, $publishedNodes)
	preStoreClassAttribute ($classAttribute, $version)
	preStoreDefinedClassAttribute ($classAttribute)
	serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	sortKey ($contentObjectAttribute)
	sortKeyType ()
	storeObjectAttribute ($contentObjectattribute)
	title ($contentObjectAttribute, $name=null)
	toString ($contentObjectAttribute)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	validateClassAttributeHTTPInput ($http, $base, $classAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
	$IntegerValidator
const	DATA_TYPE_STRING = "ezidentifier"
const	DIGITS_FIELD = "data_int2"
const	DIGITS_VARIABLE = "_ezidentifier_digits_integer_value_"
const	IDENTIFIER_FIELD = "data_int3"
const	IDENTIFIER_VARIABLE = "_ezidentifier_identifier_value_"
const	POSTTEXT_FIELD = "data_text2"
const	POSTTEXT_VARIABLE = "_ezidentifier_posttext_value_"
const	PRETEXT_FIELD = "data_text1"
const	PRETEXT_VARIABLE = "_ezidentifier_pretext_value_"
const	START_VALUE_FIELD = "data_int1"
const	START_VALUE_VARIABLE = "_ezidentifier_start_integer_value_"
Private Member Functions
	assignValue ($contentClassAttribute, $contentObjectAttribute)
	storeIdentifierValue ($contentClassAttribute, $contentObjectAttribute, $identifierValue)

Detailed Description

The class eZIdentifierType does.

Definition at line 18 of file ezidentifiertype.php.

Member Function Documentation

eZIdentifierType::assignValue	(	$	contentClassAttribute,
		$	contentObjectAttribute
	)		`[private]`

Assigns the identifiervalue for the first version of the current attribute.

Definition at line 246 of file ezidentifiertype.php.

Referenced by initializeObjectAttribute(), and onPublish().

eZIdentifierType::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 359 of file ezidentifiertype.php.

eZIdentifierType::eZIdentifierType ( )

Constructor

Definition at line 40 of file ezidentifiertype.php.

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

Fetches the HTTP input for the content class attribute.

Note:: Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 143 of file ezidentifiertype.php.

eZIdentifierType::fetchObjectAttributeHTTPInput	(	$	http,
		$	base,
		$	objectAttribute
	)

Fetches the HTTP input for the content object attribute.

Note:: Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 58 of file ezidentifiertype.php.

eZIdentifierType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 90 of file ezidentifiertype.php.

eZIdentifierType::generateIdentifierString	(	$	contentClassAttribute,
		$	identifierValue = `false`
	)

Definition at line 344 of file ezidentifiertype.php.

Referenced by objectAttributeContent(), and storeIdentifierValue().

eZIdentifierType::hasObjectAttributeContent ( $ contentObjectAttribute )

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

Reimplemented from eZDataType.

Definition at line 97 of file ezidentifiertype.php.

eZIdentifierType::initializeClassAttribute ( $ classAttribute )

Initializes the class attribute with some data.

Note:: Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 103 of file ezidentifiertype.php.

eZIdentifierType::initializeObjectAttribute	(	$	objectAttribute,
		$	currentVersion,
		$	originalContentObjectAttribute
	)

Initializes the object attribute with some data.

Note:: Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 217 of file ezidentifiertype.php.

eZIdentifierType::isIndexable ( )

Returns:: true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 211 of file ezidentifiertype.php.

eZIdentifierType::metaData ( $ contentObjectAttribute )

Returns the meta data used for storing search indices.

Reimplemented from eZDataType.

Definition at line 198 of file ezidentifiertype.php.

eZIdentifierType::objectAttributeContent ( $ contentObjectAttribute )

Returns the content.

Reimplemented from eZDataType.

Definition at line 73 of file ezidentifiertype.php.

eZIdentifierType::onPublish	(	$	contentObjectAttribute,
		$	contentObject,
		$	publishedNodes
	)

When published it will check if it needs to aquire a new unique identifier, if so it updates all existing versions with this new identifier.

Reimplemented from eZDataType.

Definition at line 234 of file ezidentifiertype.php.

eZIdentifierType::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 363 of file ezidentifiertype.php.

eZIdentifierType::preStoreDefinedClassAttribute ( $ classAttribute )

Parameters:

eZContentClassAttribute $classAttribute Content class attribute of the datatype

Reimplemented from eZDataType.

Definition at line 367 of file ezidentifiertype.php.

eZIdentifierType::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 371 of file ezidentifiertype.php.

eZIdentifierType::sortKey ( $ objectAttribute )

Returns:: the sort key for the datatype. This is used for sorting on attribute level.

Reimplemented from eZDataType.

Definition at line 321 of file ezidentifiertype.php.

eZIdentifierType::sortKeyType ( )

Returns:: the type of the sort key int|string False is returned if sorting is not supported

Reimplemented from eZDataType.

Definition at line 327 of file ezidentifiertype.php.

eZIdentifierType::storeIdentifierValue	(	$	contentClassAttribute,
		$	contentObjectAttribute,
		$	identifierValue
	)		`[private]`

Store the new value to the attribute.

Definition at line 336 of file ezidentifiertype.php.

Referenced by assignValue().

eZIdentifierType::storeObjectAttribute ( $ contentObjectattribute )

Store the content. Since the content has been stored in function fetchObjectAttributeHTTPInput(), this function is with empty code.

Reimplemented from eZDataType.

Definition at line 66 of file ezidentifiertype.php.

eZIdentifierType::title	(	$	contentObjectAttribute,
		$	name = `null`
	)

Returns the text.

Reimplemented from eZDataType.

Definition at line 206 of file ezidentifiertype.php.

eZIdentifierType::toString ( $ objectAttribute )

Returns:: string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 84 of file ezidentifiertype.php.

eZIdentifierType::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 398 of file ezidentifiertype.php.

eZIdentifierType::validateClassAttributeHTTPInput	(	$	http,
		$	base,
		$	classAttribute
	)

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

Reimplemented from eZDataType.

Definition at line 119 of file ezidentifiertype.php.

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

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

Reimplemented from eZDataType.

Definition at line 54 of file ezidentifiertype.php.

Member Data Documentation

eZIdentifierType::$IntegerValidator

Definition at line 422 of file ezidentifiertype.php.

const eZIdentifierType::DATA_TYPE_STRING = "ezidentifier"

Definition at line 35 of file ezidentifiertype.php.

const eZIdentifierType::DIGITS_FIELD = "data_int2"

Definition at line 29 of file ezidentifiertype.php.

const eZIdentifierType::DIGITS_VARIABLE = "_ezidentifier_digits_integer_value_"

Definition at line 30 of file ezidentifiertype.php.

const eZIdentifierType::IDENTIFIER_FIELD = "data_int3"

Definition at line 32 of file ezidentifiertype.php.

const eZIdentifierType::IDENTIFIER_VARIABLE = "_ezidentifier_identifier_value_"

Definition at line 33 of file ezidentifiertype.php.

const eZIdentifierType::POSTTEXT_FIELD = "data_text2"

Definition at line 23 of file ezidentifiertype.php.

const eZIdentifierType::POSTTEXT_VARIABLE = "_ezidentifier_posttext_value_"

Definition at line 24 of file ezidentifiertype.php.

const eZIdentifierType::PRETEXT_FIELD = "data_text1"

Definition at line 20 of file ezidentifiertype.php.

const eZIdentifierType::PRETEXT_VARIABLE = "_ezidentifier_pretext_value_"

Definition at line 21 of file ezidentifiertype.php.

const eZIdentifierType::START_VALUE_FIELD = "data_int1"

Definition at line 26 of file ezidentifiertype.php.

const eZIdentifierType::START_VALUE_VARIABLE = "_ezidentifier_start_integer_value_"

Definition at line 27 of file ezidentifiertype.php.

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

ezidentifiertype.php

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation