Manual

SDK

 
   

API Reference
 

Sections

Todo

eZURL Class Reference
[Kernel system]

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

Inheritance diagram for eZURL:

eZPersistentObject List of all members.

Public Methods

& definition ()
 setModified ($dateTime=false)
& fetch ($id,$asObject=true)
& fetchListCount ($parameters=array())
& fetchList ($parameters=array())
& handleList ($parameters=array(),$asCount=false)

Static Public Methods

 registerURL ($url)
 setIsValid ($id,$isValid)
& url ($id,$onlyValid=false)
& urlByMD5 ($urlMD5)

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 ezurl.php.

Member Function Documentation

& 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 ezurl.php.

References url().

Referenced by setIsValid().

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

Returns:
the url object for id $id.

Definition at line ezurl.php.

References eZPersistentObject::fetchObject().

& eZURL::fetchList (  $    parameters = array() ) 
 

Returns:
all registered URLs.

Definition at line ezurl.php.

References handleList().

& eZURL::fetchListCount (  $    parameters = array() ) 
 

Returns:
the number of registered URLs.

Definition at line ezurl.php.

References handleList().

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

Returns:
all registered URLs.

Definition at line ezurl.php.

References eZPersistentObject::fetchObjectList().

Referenced by 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 ezurl.php.

References url().

Referenced by 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 ezurl.php.

References definition().

eZURL::setModified (  $    dateTime = false ) 
 

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

Definition at line ezurl.php.

References eZDateTime::currentTimeStamp().

& 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 ezurl.php.

References url().

Referenced by urlByMD5().

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

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

Definition at line ezurl.php.

References url().

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

Exponential