eZPublish  3.8
eZURL Class Reference

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

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

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)
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

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.

Member Function Documentation

eZURL::definition ( )
eZURL::eZURL (   $row)

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

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

Referenced by eZURLFunctionCollection\fetchList().

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

Referenced by eZURLFunctionCollection\fetchListCount().

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

Referenced by fetchList(), and fetchListCount().

eZURL::registerURLArray (   $urlArray)
static

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

eZURL::removeByID (   $urlID)
static

Removes the URL with ID $urlID.

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

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

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.

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(), eZPDFXMLOutput\renderPDFTag(), and eZXHTMLXMLOutput\renderXHTMLTag().

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().

eZURL::urlByURL (   $urlText)
static

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

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


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