eZPublishCommunityProject(LegacyStack)  2013.9
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)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static create ($url)
 
static definition ()
 
static fetch ($id, $asObject=true)
 
static fetchByUrl ($url, $asObject=true)
 Fetches an URL object from an url string. More...
 
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. More...
 
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)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

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::fetchByUrl (   $url,
  $asObject = true 
)
static

Fetches an URL object from an url string.

Parameters
string$url
bool$asObject
Returns
eZURL|null
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

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

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.

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: