eZPublishCommunityProject  2013.5
eZ\Publish\API\Repository\Values\ValueObject Class Reference

Inherited by eZ\Publish\API\Repository\Values\Content\Content, eZ\Publish\API\Repository\Values\Content\ContentCreateStruct, eZ\Publish\API\Repository\Values\Content\ContentInfo, eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct, eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct, eZ\Publish\API\Repository\Values\Content\Field, eZ\Publish\API\Repository\Values\Content\Language, eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct, eZ\Publish\API\Repository\Values\Content\Location, eZ\Publish\API\Repository\Values\Content\LocationCreateStruct, eZ\Publish\API\Repository\Values\Content\LocationList, eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct, eZ\Publish\API\Repository\Values\Content\Query, eZ\Publish\API\Repository\Values\Content\Query\FacetBuilder, eZ\Publish\API\Repository\Values\Content\Relation, eZ\Publish\API\Repository\Values\Content\Search\Facet, eZ\Publish\API\Repository\Values\Content\Search\SearchHit, eZ\Publish\API\Repository\Values\Content\Search\SearchResult, eZ\Publish\API\Repository\Values\Content\SearchResult, eZ\Publish\API\Repository\Values\Content\Section, eZ\Publish\API\Repository\Values\Content\SectionCreateStruct, eZ\Publish\API\Repository\Values\Content\SectionUpdateStruct, eZ\Publish\API\Repository\Values\Content\TranslationInfo, eZ\Publish\API\Repository\Values\Content\TranslationValues, eZ\Publish\API\Repository\Values\Content\URLAlias, eZ\Publish\API\Repository\Values\Content\URLWildcard, eZ\Publish\API\Repository\Values\Content\URLWildcardTranslationResult, eZ\Publish\API\Repository\Values\Content\VersionInfo, eZ\Publish\API\Repository\Values\ContentType\ContentType, eZ\Publish\API\Repository\Values\ContentType\ContentTypeCreateStruct, eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup, eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroupCreateStruct, eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroupUpdateStruct, eZ\Publish\API\Repository\Values\ContentType\ContentTypeUpdateStruct, eZ\Publish\API\Repository\Values\ContentType\FieldDefinition, eZ\Publish\API\Repository\Values\ContentType\FieldDefinitionCreateStruct, eZ\Publish\API\Repository\Values\ContentType\FieldDefinitionUpdateStruct, eZ\Publish\API\Repository\Values\ObjectState\ObjectState, eZ\Publish\API\Repository\Values\ObjectState\ObjectStateCreateStruct, eZ\Publish\API\Repository\Values\ObjectState\ObjectStateGroup, eZ\Publish\API\Repository\Values\ObjectState\ObjectStateGroupCreateStruct, eZ\Publish\API\Repository\Values\ObjectState\ObjectStateGroupUpdateStruct, eZ\Publish\API\Repository\Values\ObjectState\ObjectStateUpdateStruct, eZ\Publish\API\Repository\Values\Translation, eZ\Publish\API\Repository\Values\User\Limitation, eZ\Publish\API\Repository\Values\User\Policy, eZ\Publish\API\Repository\Values\User\PolicyCreateStruct, eZ\Publish\API\Repository\Values\User\PolicyUpdateStruct, eZ\Publish\API\Repository\Values\User\Role, eZ\Publish\API\Repository\Values\User\RoleAssignment, eZ\Publish\API\Repository\Values\User\RoleCreateStruct, eZ\Publish\API\Repository\Values\User\RoleUpdateStruct, eZ\Publish\API\Repository\Values\User\UserGroupUpdateStruct, eZ\Publish\API\Repository\Values\User\UserUpdateStruct, eZ\Publish\Core\FieldType\Page\Parts\Base, eZ\Publish\Core\FieldType\Page\Parts\Item, eZ\Publish\Core\FieldType\Value, eZ\Publish\Core\IO\Values\BinaryFile, eZ\Publish\Core\IO\Values\BinaryFileCreateStruct, eZ\Publish\Core\MVC\Symfony\Routing\SimplifiedRequest, eZ\Publish\Core\REST\Client\Values\RestContentInfo, eZ\Publish\Core\REST\Server\Values\CreatedContent, eZ\Publish\Core\REST\Server\Values\CreatedContentType, eZ\Publish\Core\REST\Server\Values\CreatedContentTypeGroup, eZ\Publish\Core\REST\Server\Values\CreatedFieldDefinition, eZ\Publish\Core\REST\Server\Values\CreatedLocation, eZ\Publish\Core\REST\Server\Values\CreatedObjectState, eZ\Publish\Core\REST\Server\Values\CreatedObjectStateGroup, eZ\Publish\Core\REST\Server\Values\CreatedPolicy, eZ\Publish\Core\REST\Server\Values\CreatedRelation, eZ\Publish\Core\REST\Server\Values\CreatedRole, eZ\Publish\Core\REST\Server\Values\CreatedSection, eZ\Publish\Core\REST\Server\Values\CreatedURLAlias, eZ\Publish\Core\REST\Server\Values\CreatedURLWildcard, eZ\Publish\Core\REST\Server\Values\CreatedUser, eZ\Publish\Core\REST\Server\Values\CreatedUserGroup, eZ\Publish\Core\REST\Server\Values\CreatedVersion, eZ\Publish\Core\REST\Server\Values\RestExecutedView, eZ\Publish\Core\REST\Server\Values\SessionInput, eZ\Publish\Core\SignalSlot\Signal, eZ\Publish\SPI\Persistence\ValueObject, and eZ\Publish\SPI\Variation\Values\Variation.

Public Member Functions

 __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...
 

Static Public Member Functions

static __set_state (array $array)
 Returns a new instance of this class with the data specified by $array. More...
 

Protected Member Functions

 getProperties ($dynamicProperties=array())
 Function where list of properties are returned. More...
 

Constructor & Destructor Documentation

eZ\Publish\API\Repository\Values\ValueObject::__construct ( array  $properties = array())

Construct object optionally with a set of properties.

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters
array$properties

Member Function Documentation

eZ\Publish\API\Repository\Values\ValueObject::__get (   $property)

Magic get function handling read to non public properties.

Returns value for all readonly (protected) properties.

This method is for internal use private

Exceptions
\eZ\Publish\API\Repository\Exceptions\PropertyNotFoundExceptionexception on all reads to undefined properties so typos are not silently accepted.
Parameters
string$propertyName of the property
Returns
mixed

Referenced by eZ\Publish\API\Repository\Values\ValueObject\attribute().

eZ\Publish\API\Repository\Values\ValueObject::__isset (   $property)

Magic isset function handling isset() to non public properties.

Returns true for all (public/)protected/private properties.

This method is for internal use private

Parameters
string$propertyName of the property
Returns
boolean

Referenced by eZ\Publish\API\Repository\Values\ValueObject\getProperties(), and eZ\Publish\API\Repository\Values\ValueObject\hasAttribute().

eZ\Publish\API\Repository\Values\ValueObject::__set (   $property,
  $value 
)

Magic set function handling writes to non public properties.

This method is for internal use private

Exceptions
\eZ\Publish\API\Repository\Exceptions\PropertyNotFoundExceptionWhen property does not exist
\eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyExceptionWhen property is readonly (protected)
Parameters
string$propertyName of the property
string$value
Returns
void

Referenced by eZ\Publish\API\Repository\Values\ValueObject\__unset().

static eZ\Publish\API\Repository\Values\ValueObject::__set_state ( array  $array)
static

Returns a new instance of this class with the data specified by $array.

$array contains all the data members of this class in the form: array('member_name'=>value).

__set_state makes this class exportable with var_export. var_export() generates code, that calls this method when it is parsed with PHP.

This method is for internal use private

Parameters
mixed[]$array
Returns
ValueObject
eZ\Publish\API\Repository\Values\ValueObject::__unset (   $property)

Magic unset function handling unset() to non public properties.

This method is for internal use private

Exceptions
\eZ\Publish\API\Repository\Exceptions\PropertyNotFoundExceptionexception on all writes to undefined properties so typos are not silently accepted and
\eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyExceptionexception on readonly (protected) properties.

__set()

Parameters
string$propertyName of the property
Returns
boolean
eZ\Publish\API\Repository\Values\ValueObject::attribute (   $property)
final

Internal function for Legacy template engine compatibility to get property value.

This method is for internal use private

Deprecated:
Since 5.0, available purely for legacy eZTemplate compatibility __get()
Parameters
string$property
Returns
mixed
eZ\Publish\API\Repository\Values\ValueObject::attributes ( )
final

Internal function for Legacy template engine compatibility to get properties.

This method is for internal use private

Deprecated:
Since 5.0, available purely for legacy eZTemplate compatibility __isset()
Returns
array

Referenced by eZ\Publish\Core\FieldType\Page\Parts\Base\__construct().

eZ\Publish\API\Repository\Values\ValueObject::getProperties (   $dynamicProperties = array())
protected

Function where list of properties are returned.

Used by {

See Also
attributes()}, override to add dynamic properties __isset()
Todo:
Make object traversable and reuse this function there (hence why this is not exposed)
Parameters
array$dynamicPropertiesAdditional dynamic properties exposed on the object
Returns
array

Referenced by eZ\Publish\API\Repository\Values\ValueObject\attributes(), eZ\Publish\Core\FieldType\Page\Parts\Base\getState(), and eZ\Publish\Core\FieldType\Page\Parts\Item\getState().

eZ\Publish\API\Repository\Values\ValueObject::hasAttribute (   $property)
final

Internal function for Legacy template engine compatibility to check existence of property.

This method is for internal use private

Deprecated:
Since 5.0, available purely for legacy eZTemplate compatibility __isset()
Parameters
string$property
Returns
boolean

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