eZURL Class Reference
[Content datatypes]

A class which handles central storage of urls. More...

Inheritance diagram for eZURL:

List of all members.

Public Member Functions
	create ($url)
	definition ()
	eZURL ($row)
	fetch ($id, $asObject=true)
	fetchList ($parameters=array())
	fetchListCount ($parameters=array())
	handleList ($parameters=array(), $asCount=false)
	setLastChecked ($id, $dateTime=false)
	setModified ($dateTime=false)
Static Public Member Functions
	registerURL ($url)
	registerURLArray ($urlArray)
	removeByID ($urlID)
	setIsValid ($id, $isValid)
	url ($id, $onlyValid=false)
	urlByMD5 ($urlMD5)
	urlByURL ($urlText)

---

Detailed Description

A class which handles central storage of urls.

URLs can be stored using eZURL. When registering URL's to eZURL you will get a URL ID which is used to identify URLs.

Definition at line 44 of file ezurl.php.

---

Member Function Documentation

eZURL::create

(

$

url

)

Definition at line 89 of file ezurl.php.

Referenced by registerURL(), and registerURLArray().

eZURL::definition

(

)

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 53 of file ezurl.php.

Referenced by fetch(), handleList(), removeByID(), setIsValid(), and setLastChecked().

eZURL::eZURL

(

$

row

)

Definition at line 48 of file ezurl.php.

Referenced by create(), handleList(), and urlByURL().

eZURL::fetch	(	$	id,
		$	asObject = true
	)

Returns:

the url object for id $id.

Definition at line 227 of file ezurl.php.

Referenced by eZURLType::hasObjectAttributeContent(), eZXMLTextType::serializeContentObjectAttribute(), eZURLType::serializeContentObjectAttribute(), and eZURLType::unserializeContentObjectAttribute().

eZURL::fetchList

(

$

parameters = array()

)

Returns:

all registered URLs.

Definition at line 245 of file ezurl.php.

eZURL::fetchListCount

(

$

parameters = array()

)

Returns:

the number of registered URLs.

Definition at line 237 of file ezurl.php.

eZURL::handleList	(	$	parameters = array(),
		$	asCount = false
	)

Returns:

all registered URLs.

Definition at line 253 of file ezurl.php.

Referenced by fetchList(), and fetchListCount().

eZURL::registerURL

(

$

url

)

[static]

Registers a URL to the URL database. The URL id is returned if successful. False is returned if not.

Definition at line 118 of file ezurl.php.

Referenced by eZSimplifiedXMLInputParser::convertHrefToID(), eZURLType::fromString(), eZURLOperator::modify(), eZURLType::postStore(), eZSimplifiedXMLInputParser::publishHandlerObject(), eZURLType::storeObjectAttribute(), eZURLType::unserializeContentObjectAttribute(), and eZURLOperator::urlTransformation().

eZURL::registerURLArray

(

$

urlArray

)

[static]

Registers an array of URLs to the URL database. A hash of array( url -> id ) is returned.

Definition at line 146 of file ezurl.php.

eZURL::removeByID

(

$

urlID

)

[static]

Removes the URL with ID $urlID.

Definition at line 107 of file ezurl.php.

Referenced by eZURLType::deleteStoredObjectAttribute(), and eZURLType::storeObjectAttribute().

eZURL::setIsValid	(	$	id,
		$	isValid
	)			[static]

Updates the is_valid field of urls passed in $id.

Parameters:

$id

Can either be an array with ids or just one id value.

Definition at line 186 of file ezurl.php.

eZURL::setLastChecked	(	$	id,
		$	dateTime = false
	)

Sets the last checked date to $dateTime or the current date if it's false.

Definition at line 213 of file ezurl.php.

eZURL::setModified

(

$

dateTime = false

)

Sets the modification date to $dateTime or the current date if it's false.

Definition at line 200 of file ezurl.php.

eZURL::url	(	$	id,
		$	onlyValid = false
	)			[static]

Returns the URL with the given ID. False is returned if the ID does not exits.

Definition at line 379 of file ezurl.php.

Referenced by eZURLType::objectAttributeContent(), eZSimplifiedXMLEditOutput::outputObject(), and eZURLType::toString().

eZURL::urlByMD5

(

$

urlMD5

)

[static]

Returns the URL with the given ID. False is returned if the ID does not exits.

Definition at line 411 of file ezurl.php.

Referenced by eZURLOperator::modify(), and eZURLOperator::urlTransformation().

eZURL::urlByURL

(

$

urlText

)

[static]

Returns the URL with the given URL. Returns false if the URL does not exists.

Definition at line 431 of file ezurl.php.

Referenced by eZXMLTextType::unserializeContentObjectAttribute(), and eZContentObjectTreeNode::updateSubTreePath().

---

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

• ezurl.php