eZPublishCommunityProject  2013.5
eZ\Publish\Core\Repository\Values\Content\Location Class Reference

This class represents a location in the repository. More...

+ Inheritance diagram for eZ\Publish\Core\Repository\Values\Content\Location:
+ Collaboration diagram for eZ\Publish\Core\Repository\Values\Content\Location:

Public Member Functions

 __get ($property)
 Magic getter for retrieving convenience properties. More...
 
 __isset ($property)
 Magic isset for signaling existence of convenience properties. More...
 
 getContentInfo ()
 Returns the content info of the content object of this location. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Location
 getContentInfo ()
 Returns the content info of the content object of this location. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
 __construct (array $properties=array())
 Construct object optionally with a set of properties. More...
 
 __get ($property)
 Magic get function handling read to non public properties. More...
 
 __isset ($property)
 Magic isset function handling isset() to non public properties. More...
 
 __set ($property, $value)
 Magic set function handling writes to non public properties. More...
 
 __unset ($property)
 Magic unset function handling unset() to non public properties. More...
 
 attribute ($property)
 Internal function for Legacy template engine compatibility to get property value. More...
 
 attributes ()
 Internal function for Legacy template engine compatibility to get properties. More...
 
 hasAttribute ($property)
 Internal function for Legacy template engine compatibility to check existence of property. More...
 

Protected Member Functions

 getProperties ($dynamicProperties=array( 'contentId'))
 Function where list of properties are returned. More...
 
- Protected Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
 getProperties ($dynamicProperties=array())
 Function where list of properties are returned. More...
 

Protected Attributes

 $contentInfo
 
 $path
 
- Protected Attributes inherited from eZ\Publish\API\Repository\Values\Content\Location
 $depth
 
 $hidden
 
 $id
 
 $invisible
 
 $parentLocationId
 
 $pathString
 
 $priority
 
 $remoteId
 
 $sortField
 
 $sortOrder
 

Additional Inherited Members

- Static Public Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
static __set_state (array $array)
 Returns a new instance of this class with the data specified by $array. More...
 
- Public Attributes inherited from eZ\Publish\API\Repository\Values\Content\Location
const SORT_FIELD_CLASS_IDENTIFIER = 6
 
const SORT_FIELD_CLASS_NAME = 7
 
const SORT_FIELD_CONTENTOBJECT_ID = 12
 
const SORT_FIELD_DEPTH = 5
 
const SORT_FIELD_MODIFIED = 3
 
const SORT_FIELD_MODIFIED_SUBNODE = 10
 
const SORT_FIELD_NAME = 9
 
const SORT_FIELD_NODE_ID = 11
 
const SORT_FIELD_PATH = 1
 
const SORT_FIELD_PRIORITY = 8
 
const SORT_FIELD_PUBLISHED = 2
 
const SORT_FIELD_SECTION = 4
 
const SORT_ORDER_ASC = 1
 
const SORT_ORDER_DESC = 0
 

Detailed Description

This class represents a location in the repository.

Member Function Documentation

eZ\Publish\Core\Repository\Values\Content\Location::__get (   $property)

Magic getter for retrieving convenience properties.

Parameters
string$propertyThe name of the property to retrieve
Returns
mixed
eZ\Publish\Core\Repository\Values\Content\Location::__isset (   $property)

Magic isset for signaling existence of convenience properties.

Parameters
string$property
Returns
boolean
eZ\Publish\Core\Repository\Values\Content\Location::getContentInfo ( )

Returns the content info of the content object of this location.

Returns
eZ\Publish\Core\Repository\Values\Content\Location::getProperties (   $dynamicProperties = array( 'contentId' ))
protected

Function where list of properties are returned.

Override to add dynamic properties parent::getProperties()

Parameters
array$dynamicProperties
Returns
array

Member Data Documentation

eZ\Publish\Core\Repository\Values\Content\Location::$contentInfo
protected
eZ\Publish\Core\Repository\Values\Content\Location::$path
protected

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