eZPublishCommunityProject  2013.5
eZ\Publish\Core\REST\Client\Values\User\UserGroup Class Reference

Implementation of the eZ\Publish\API\Repository\Values\User\UserGroupclass. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Client\Values\User\UserGroup:
+ Collaboration diagram for eZ\Publish\Core\REST\Client\Values\User\UserGroup:

Public Member Functions

 __get ($property)
 
 getFields ()
 This method returns the complete fields collection. More...
 
 getFieldsByLanguage ($languageCode=null)
 This method returns the fields for a given language and non translatable fields. More...
 
 getFieldValue ($fieldDefIdentifier, $languageCode=null)
 Returns a field value for the given value $version->fields[$fieldDefId][$languageCode] is an equivalent call if no language is given on a translatable field this method returns the value of the initial language of the version if present, otherwise null. More...
 
 getVersionInfo ()
 Returns the VersionInfo for this version. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Content
 getFields ()
 This method returns the complete fields collection. More...
 
 getFieldsByLanguage ($languageCode=null)
 This method returns the fields for a given language and non translatable fields. More...
 
 getFieldValue ($fieldDefIdentifier, $languageCode=null)
 Returns a field value for the given value $version->fields[$fieldDefId][$languageCode] is an equivalent call if no language is given on a translatable field this method returns the value of the initial language of the version if present, otherwise null. More...
 
 getVersionInfo ()
 Returns the VersionInfo for this version. 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

 $content
 
- Protected Attributes inherited from eZ\Publish\API\Repository\Values\User\UserGroup
 $parentId
 
 $subGroupCount
 

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

Implementation of the eZ\Publish\API\Repository\Values\User\UserGroupclass.

See Also

Member Function Documentation

eZ\Publish\Core\REST\Client\Values\User\UserGroup::__get (   $property)
eZ\Publish\Core\REST\Client\Values\User\UserGroup::getFields ( )

This method returns the complete fields collection.

Returns
[]

Referenced by eZ\Publish\Core\REST\Client\Values\User\UserGroup\__get().

eZ\Publish\Core\REST\Client\Values\User\UserGroup::getFieldsByLanguage (   $languageCode = null)

This method returns the fields for a given language and non translatable fields.

If note set the initialLanguage of the content version is used.

Parameters
string$languageCode
Returns
[] With field identifier as keys
eZ\Publish\Core\REST\Client\Values\User\UserGroup::getFieldValue (   $fieldDefIdentifier,
  $languageCode = null 
)

Returns a field value for the given value $version->fields[$fieldDefId][$languageCode] is an equivalent call if no language is given on a translatable field this method returns the value of the initial language of the version if present, otherwise null.

On non translatable fields this method ignores the languageCode parameter.

Parameters
string$fieldDefIdentifier
string$languageCode
Returns
mixed a primitive type or a field type Value object depending on the field type.
eZ\Publish\Core\REST\Client\Values\User\UserGroup::getVersionInfo ( )

Returns the VersionInfo for this version.

Returns
VersionInfo

Referenced by eZ\Publish\Core\REST\Client\Values\User\UserGroup\__get().

Member Data Documentation

eZ\Publish\Core\REST\Client\Values\User\UserGroup::$content
protected

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