eZPublishCommunityProject  2013.9
eZ\Publish\Core\Repository\Values\User\User Class Reference

This class represents a user value. More...

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

Public Member Functions

 __get ($property)
 Magic getter for retrieving convenience properties. More...
 
 __isset ($property)
 Magic isset for signaling existence of convenience properties. More...
 
 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...
 

Public Attributes

const PASSWORD_HASH_MD5_PASSWORD = 1
 
const PASSWORD_HASH_MD5_SITE = 3
 
const PASSWORD_HASH_MD5_USER = 2
 
const PASSWORD_HASH_PLAINTEXT = 5
 

Protected Member Functions

 getProperties ($dynamicProperties=array( 'id', 'contentInfo'))
 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

 $content
 
- Protected Attributes inherited from eZ\Publish\API\Repository\Values\User\User
 $email
 
 $enabled = false
 
 $hashAlgorithm
 
 $login
 
 $maxLogin
 
 $passwordHash
 

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

Detailed Description

This class represents a user value.

Member Function Documentation

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

Magic getter for retrieving convenience properties.

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

Magic isset for signaling existence of convenience properties.

Parameters
string$property
Returns
boolean
eZ\Publish\Core\Repository\Values\User\User::getFields ( )

This method returns the complete fields collection.

Returns
[]

Referenced by eZ\Publish\Core\Repository\Values\User\User\__get().

eZ\Publish\Core\Repository\Values\User\User::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\Repository\Values\User\User::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\Repository\Values\User\User::getProperties (   $dynamicProperties = array( 'id', 'contentInfo' ))
protected

Function where list of properties are returned.

Override to add dynamic properties parent::getProperties()

Parameters
array$dynamicProperties
Returns
array
eZ\Publish\Core\Repository\Values\User\User::getVersionInfo ( )

Returns the VersionInfo for this version.

Returns

Referenced by eZ\Publish\Core\Repository\Values\User\User\__get().

Member Data Documentation

eZ\Publish\Core\Repository\Values\User\User::$content
protected
const eZ\Publish\Core\Repository\Values\User\User::PASSWORD_HASH_MD5_PASSWORD = 1
const eZ\Publish\Core\Repository\Values\User\User::PASSWORD_HASH_MD5_SITE = 3
const eZ\Publish\Core\Repository\Values\User\User::PASSWORD_HASH_MD5_USER = 2
const eZ\Publish\Core\Repository\Values\User\User::PASSWORD_HASH_PLAINTEXT = 5

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