PHP Class eZ\Publish\Core\Repository\Values\User\UserGroup

Inheritance: extends eZ\Publish\API\Repository\Values\User\UserGroup
Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property Type Description
$content eZ\Publish\API\Repository\Values\Content\Content Internal content representation.

Public Methods

Method Description
__get ( string $property ) : mixed Magic getter for retrieving convenience properties.
__isset ( string $property ) : boolean Magic isset for signaling existence of convenience properties.
getField ( string $fieldDefIdentifier, string | null $languageCode = null ) : eZ\Publish\API\Repository\Values\Content\Field | null This method returns the field for a given field definition identifier and language.
getFieldValue ( string $fieldDefIdentifier, string $languageCode = null ) : mixed 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.
getFields ( ) : eZ\Publish\API\Repository\Values\Content\Field[] This method returns the complete fields collection.
getFieldsByLanguage ( string $languageCode = null ) : eZ\Publish\API\Repository\Values\Content\Field[] This method returns the fields for a given language and non translatable fields.
getVersionInfo ( ) : eZ\Publish\API\Repository\Values\Content\VersionInfo Returns the VersionInfo for this version.

Protected Methods

Method Description
getProperties ( array $dynamicProperties = ['id', 'contentInfo'] ) : array Function where list of properties are returned.

Method Details

__get() public method

Magic getter for retrieving convenience properties.
public __get ( string $property ) : mixed
$property string The name of the property to retrieve
return mixed

__isset() public method

Magic isset for signaling existence of convenience properties.
public __isset ( string $property ) : boolean
$property string
return boolean

getField() public method

If not set the initialLanguage of the content version is used.
public getField ( string $fieldDefIdentifier, string | null $languageCode = null ) : eZ\Publish\API\Repository\Values\Content\Field | null
$fieldDefIdentifier string
$languageCode string | null
return eZ\Publish\API\Repository\Values\Content\Field | null A {@link Field} or null if nothing is found

getFieldValue() public method

On non translatable fields this method ignores the languageCode parameter.
public getFieldValue ( string $fieldDefIdentifier, string $languageCode = null ) : mixed
$fieldDefIdentifier string
$languageCode string
return mixed a primitive type or a field type Value object depending on the field type.

getFields() public method

This method returns the complete fields collection.
public getFields ( ) : eZ\Publish\API\Repository\Values\Content\Field[]
return eZ\Publish\API\Repository\Values\Content\Field[]

getFieldsByLanguage() public method

If note set the initialLanguage of the content version is used.
public getFieldsByLanguage ( string $languageCode = null ) : eZ\Publish\API\Repository\Values\Content\Field[]
$languageCode string
return eZ\Publish\API\Repository\Values\Content\Field[] with field identifier as keys

getProperties() protected method

Override to add dynamic properties
protected getProperties ( array $dynamicProperties = ['id', 'contentInfo'] ) : array
$dynamicProperties array
return array

getVersionInfo() public method

Returns the VersionInfo for this version.
public getVersionInfo ( ) : eZ\Publish\API\Repository\Values\Content\VersionInfo
return eZ\Publish\API\Repository\Values\Content\VersionInfo

Property Details

$content protected property

Internal content representation.
protected Content,eZ\Publish\API\Repository\Values\Content $content
return eZ\Publish\API\Repository\Values\Content\Content