eZ Publish  [4.2]
eZURLObjectLink Class Reference

The class eZURLObjectLink does. More...

+ Inheritance diagram for eZURLObjectLink:
+ Collaboration diagram for eZURLObjectLink:

List of all members.

Public Member Functions

 eZURLObjectLink ($row)

Static Public Member Functions

static clearCacheForObjectLink ($urlID)
static create ($urlID, $contentObjectAttributeID, $contentObjectAttributeVersion)
static definition ()
static fetch ($urlID, $contentObjectAttributeID, $contentObjectAttributeVersion, $asObject=true)
static fetchLinkList ($contentObjectAttributeID, $contentObjectAttributeVersion, $asObject=true)
static fetchObjectVersionCount ($urlID)
static fetchObjectVersionList ($urlID, $parameters=false)
static hasObjectLinkList ($urlID)
static removeURLlinkList ($contentObjectAttributeID, $contentObjectAttributeVersion)

Public Attributes

 $ContentObjectAttributeID
 $ContentObjectAttributeVersion
 $URLID

Detailed Description

The class eZURLObjectLink does.

Definition at line 41 of file ezurlobjectlink.php.


Member Function Documentation

static eZURLObjectLink::clearCacheForObjectLink ( urlID) [static]

Clear view cache for every object which contains URL with given link ID $urlID.

Definition at line 222 of file ezurlobjectlink.php.

static eZURLObjectLink::create ( urlID,
contentObjectAttributeID,
contentObjectAttributeVersion 
) [static]

Definition at line 82 of file ezurlobjectlink.php.

Referenced by eZSimplifiedXMLInput\updateUrlObjectLinks().

static eZURLObjectLink::definition ( ) [static]
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:

static 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 51 of file ezurlobjectlink.php.

Referenced by clearCacheForObjectLink(), eZXMLTextType\deleteStoredObjectAttribute(), fetch(), fetchLinkList(), fetchObjectVersionCount(), fetchObjectVersionList(), eZURL\handleList(), and removeURLlinkList().

eZURLObjectLink::eZURLObjectLink ( row)

Constructor

Definition at line 46 of file ezurlobjectlink.php.

Referenced by create().

static eZURLObjectLink::fetch ( urlID,
contentObjectAttributeID,
contentObjectAttributeVersion,
asObject = true 
) [static]
static eZURLObjectLink::fetchLinkList ( contentObjectAttributeID,
contentObjectAttributeVersion,
asObject = true 
) [static]
Returns:
all links for the contenobject attribute ID $contenObjectAttributeID and version $contenObjectVersion. If $contentObjectVersion is false then all links for all versions are returned.

Definition at line 190 of file ezurlobjectlink.php.

Referenced by eZURLType\deleteStoredObjectAttribute().

static eZURLObjectLink::fetchObjectVersionCount ( urlID) [static]

Get url object count

Parameters:
urldid

Definition at line 156 of file ezurlobjectlink.php.

Referenced by hasObjectLinkList().

static eZURLObjectLink::fetchObjectVersionList ( urlID,
parameters = false 
) [static]
Returns:
all object versions which has the link.

Definition at line 118 of file ezurlobjectlink.php.

static eZURLObjectLink::hasObjectLinkList ( urlID) [static]
Returns:
true if the URL $urlID has any object links

Definition at line 109 of file ezurlobjectlink.php.

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

static eZURLObjectLink::removeURLlinkList ( contentObjectAttributeID,
contentObjectAttributeVersion 
) [static]

Removes all links for the object attribute $contentObjectAttributeID and version $contentObjectVersion. If $contentObjectVersion is false then all versions are removed as well.

Definition at line 175 of file ezurlobjectlink.php.

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


Member Data Documentation

eZURLObjectLink::$ContentObjectAttributeID

Definition at line 247 of file ezurlobjectlink.php.

eZURLObjectLink::$ContentObjectAttributeVersion

Definition at line 248 of file ezurlobjectlink.php.

eZURLObjectLink::$URLID

Definition at line 246 of file ezurlobjectlink.php.


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