eZPublish  4.4
eZURL Class Reference

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

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

Public Member Functions

 eZURL ($row)
 
 setModified ($dateTime=false)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static create ($url)
 
static definition ()
 
static fetch ($id, $asObject=true)
 
static fetchList ($parameters=array())
 
static fetchListCount ($parameters=array())
 
static handleList ($parameters=array(), $asCount=false)
 
static registerURL ($url)
 
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)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

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.

Member Function Documentation

static eZURL::create (   $url)
static
static eZURL::definition ( )
static
eZURL::eZURL (   $row)

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

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

Referenced by eZURLFunctionCollection\fetchList().

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

Referenced by eZURLFunctionCollection\fetchListCount().

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

Referenced by fetchList(), and fetchListCount().

static eZURL::registerURL (   $url)
static
static eZURL::registerURLArray (   $urlArray)
static

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

static eZURL::removeByID (   $urlID)
static

Removes the URL with ID $urlID.

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.
static eZURL::setLastChecked (   $id,
  $dateTime = false 
)
static

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

eZURL::setModified (   $dateTime = false)

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

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

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

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.

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.

Referenced by eZXMLTextType\unserializeContentObjectAttribute().


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