eZPublishCommunityProject  2013.4
eZ\Publish\Core\Repository\Values\User\PolicyUpdateStruct Class Reference

This class is used for updating a policy. More...

+ Inheritance diagram for eZ\Publish\Core\Repository\Values\User\PolicyUpdateStruct:
+ Collaboration diagram for eZ\Publish\Core\Repository\Values\User\PolicyUpdateStruct:

Public Member Functions

 addLimitation (Limitation $limitation)
 Adds a limitation to the policy - if a Limitation exists with the same identifier the existing limitation is replaced. More...
 
 getLimitations ()
 Returns list of limitations added to policy. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\User\PolicyUpdateStruct
 addLimitation (Limitation $limitation)
 Adds a limitation to the policy - if a Limitation exists with the same identifier the existing limitation is replaced. More...
 
 getLimitations ()
 Returns list of limitations added to policy. 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 Attributes

 $limitations = array()
 

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...
 
- Protected Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
 getProperties ($dynamicProperties=array())
 Function where list of properties are returned. More...
 

Detailed Description

This class is used for updating a policy.

The limitations of the policy are replaced with those which are added in instances of this class

Member Function Documentation

eZ\Publish\Core\Repository\Values\User\PolicyUpdateStruct::addLimitation ( Limitation  $limitation)

Adds a limitation to the policy - if a Limitation exists with the same identifier the existing limitation is replaced.

Parameters
\eZ\Publish\API\Repository\Values\User\Limitation$limitation
eZ\Publish\Core\Repository\Values\User\PolicyUpdateStruct::getLimitations ( )

Returns list of limitations added to policy.

Returns
[]

Member Data Documentation

eZ\Publish\Core\Repository\Values\User\PolicyUpdateStruct::$limitations = array()
protected

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