eZPublish  4.7
eZPathElement Class Reference

Handles singular path elements in URL aliases. More...

+ Inheritance diagram for eZPathElement:
+ Collaboration diagram for eZPathElement:

Public Member Functions

 actionURL ()
 alwaysAvailable ()
 eZPathElement ($row)
 getLanguage ()
 getPath ()
 getPathArray ()
 removeThis ()
 store ($fieldFilters=null)
- 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 definition ()
static fetchNamedByParentID ($parentID, $name)
- 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...

Public Attributes

- Public Attributes inherited from eZPersistentObject

Detailed Description

Handles singular path elements in URL aliases.

This class is similar to eZURLAliasML but is designed to work on single path elements instead of considering the whole url.

The definition() of this class is the same as eZURLAliasML but it is not possible to store and remove items of this class.

Member Function Documentation

eZPathElement::actionURL ( )

Converts the action property into a real url which responds to the module/view on the site.

eZPathElement::alwaysAvailable ( )
static eZPathElement::definition ( )
eZPathElement::eZPathElement (   $row)

Initializes a new path element.

Referenced by getPathArray().

static eZPathElement::fetchNamedByParentID (   $parentID,

Fetches path elements which has the parent $parentID and name $name.

An array of path element objects.
eZPathElement::getLanguage ( )

Returns the eZContentLanguage object which maches the element language mask.

eZPathElement::getPath ( )

Calculates the full path for the current item and returns it.

If you know the action values of the path use fetchPathByActionList() instead, it is more optimized.
The calculated path is cached in $Path.
eZPathElement::getPathArray ( )
eZPathElement::removeThis ( )

Removal of path elements is not allowed.

eZPathElement::store (   $fieldFilters = null)

Storing of path elements is not allowed.

Member Data Documentation


Referenced by alwaysAvailable().

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