eZURLType Class Reference

A content datatype which handles urls. More...

Inheritance diagram for eZURLType:

Collaboration diagram for eZURLType:

List of all members.

Public Member Functions
	deleteStoredObjectAttribute ($contentObjectAttribute, $version=null)
	eZURLType ()
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	fromString ($contentObjectAttribute, $string)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	postStore ($objectAttribute)
	serializeContentObjectAttribute ($package, $objectAttribute)
	storeClassAttribute ($attribute, $version)
	storeDefinedClassAttribute ($attribute)
	storeObjectAttribute ($attribute)
	supportsBatchInitializeObjectAttribute ()
	title ($contentObjectAttribute, $name=null)
	toString ($contentObjectAttribute)
	unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
	validateClassAttributeHTTPInput ($http, $base, $classAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = 'ezurl'

---

Detailed Description

A content datatype which handles urls.

Definition at line 39 of file ezurltype.php.

---

Member Function Documentation

eZURLType::deleteStoredObjectAttribute	(	$	objectAttribute,
		$	version = null
	)

Clean up stored object attribute

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 109 of file ezurltype.php.

eZURLType::eZURLType

(

)

Initializes with a url id and a description.

Definition at line 46 of file ezurltype.php.

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

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

Reimplemented from eZDataType.

Definition at line 142 of file ezurltype.php.

eZURLType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 283 of file ezurltype.php.

eZURLType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 232 of file ezurltype.php.

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

Sets the default value.

Reimplemented from eZDataType.

Definition at line 56 of file ezurltype.php.

eZURLType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 248 of file ezurltype.php.

eZURLType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 220 of file ezurltype.php.

eZURLType::postStore

(

$

objectAttribute

)

Makes some post-store operations. Called by framework after store of eZContentObjectAttribute object.

Reimplemented from eZDataType.

Definition at line 162 of file ezurltype.php.

eZURLType::serializeContentObjectAttribute	(	$	package,
		$	objectAttribute
	)

Parameters:

package
content	attribute

Returns:

a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 322 of file ezurltype.php.

eZURLType::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 204 of file ezurltype.php.

eZURLType::storeDefinedClassAttribute

(

$

classAttribute

)

Note:

Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Reimplemented from eZDataType.

Definition at line 208 of file ezurltype.php.

eZURLType::storeObjectAttribute

(

$

attribute

)

Store the URL in the URL database and store the reference to it.

Reimplemented from eZDataType.

Definition at line 184 of file ezurltype.php.

eZURLType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 386 of file ezurltype.php.

eZURLType::title	(	$	contentObjectAttribute,
		$	name = null
	)

Returns the content of the url for use as a title

Reimplemented from eZDataType.

Definition at line 256 of file ezurltype.php.

eZURLType::toString

(

$

objectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 261 of file ezurltype.php.

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

Parameters:

package
contentobject	attribute object
domnode	object

Reimplemented from eZDataType.

Definition at line 356 of file ezurltype.php.

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

Validates the input for a class attribute and returns a validation state as defined in eZInputValidator.

Note:

Default implementation does nothing and returns accepted.

Reimplemented from eZDataType.

Definition at line 212 of file ezurltype.php.

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

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

Reimplemented from eZDataType.

Definition at line 83 of file ezurltype.php.

---

Member Data Documentation

const eZURLType::DATA_TYPE_STRING = 'ezurl'

Definition at line 41 of file ezurltype.php.

---

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

• ezurltype.php