eZ Publish  [trunk]
Public Member Functions | Static Public Member Functions
eZURL Class Reference

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

+ Inheritance diagram for eZURL:
+ Collaboration diagram for eZURL:

List of all members.

Public Member Functions

 eZURL ($row)
 setModified ($dateTime=false)

Static Public Member Functions

static create ($url)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetch ($id, $asObject=true)
static fetchByUrl ($url, $asObject=true)
 Fetches an URL object from an url string.
static fetchList ($parameters=array())
static fetchListCount ($parameters=array())
static handleList ($parameters=array(), $asCount=false)
static registerURL ($url)
 Registers an URL to the URL database and returns the URL id.
static registerURLArray ($urlArray)
static removeByID ($urlID)
static setIsValid ($id, $isValid)
static setLastChecked ($id, $dateTime=false)
static url ($id, $onlyValid=false)
static urlByMD5 ($urlMD5)
static 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 22 of file ezurl.php.

Member Function Documentation

static eZURL::create ( $  url) [static]

Definition at line 66 of file ezurl.php.

Referenced by registerURL(), and registerURLArray().

static eZURL::definition ( ) [static]

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: public static 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" ); }

Returns:
array

Reimplemented from eZPersistentObject.

Definition at line 29 of file ezurl.php.

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

eZURL::eZURL ( $  row)

Definition at line 24 of file ezurl.php.

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

static eZURL::fetch ( $  id,
$  asObject = true 
) [static]
Returns:
the url object for id $id.

Definition at line 211 of file ezurl.php.

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

static eZURL::fetchByUrl ( $  url,
$  asObject = true 
) [static]

Fetches an URL object from an url string.

Parameters:
string$url
bool$asObject
Returns:
eZURL|null

Definition at line 240 of file ezurl.php.

Referenced by registerURL().

static eZURL::fetchList ( $  parameters = array()) [static]
Returns:
all registered URLs.

Definition at line 229 of file ezurl.php.

static eZURL::fetchListCount ( $  parameters = array()) [static]
Returns:
the number of registered URLs.

Definition at line 221 of file ezurl.php.

static eZURL::handleList ( $  parameters = array(),
$  asCount = false 
) [static]
Returns:
all registered URLs.

Definition at line 250 of file ezurl.php.

Referenced by fetchList(), and fetchListCount().

static eZURL::registerURL ( $  url) [static]

Registers an URL to the URL database and returns the URL id.

If URL is already present, the method will check the checksum and update the URL if needed

Parameters:
string$url
Returns:
int

Definition at line 96 of file ezurl.php.

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

static eZURL::registerURLArray ( $  urlArray) [static]

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

Definition at line 130 of file ezurl.php.

static eZURL::removeByID ( $  urlID) [static]

Removes the URL with ID $urlID.

Definition at line 84 of file ezurl.php.

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

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

Updates the is_valid field of urls passed in $id.

Parameters:
$idCan either be an array with ids or just one id value.

Definition at line 170 of file ezurl.php.

static eZURL::setLastChecked ( $  id,
$  dateTime = false 
) [static]

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

Definition at line 197 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 184 of file ezurl.php.

static 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 374 of file ezurl.php.

Referenced by eZURLType\objectAttributeContent(), eZSimplifiedXMLEditOutput\outputObject(), ezpUrlObjectLinkUpdate\processData(), and eZURLType\toString().

static eZURL::urlByMD5 ( $  urlMD5) [static]

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

Definition at line 406 of file ezurl.php.

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

static eZURL::urlByURL ( $  urlText) [static]

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

Definition at line 426 of file ezurl.php.

Referenced by eZXMLTextType\unserializeContentObjectAttribute().

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