UserAttributeValue
extends EntityBase
in package
Cx\Core\User\Model\Entity\UserAttributeValue
Table of Contents
Properties
- $attribute : UserAttribute
- The attribute this value belongs to
- $attributeId : UserAttribute
- The attribute this value belongs to
- $history : int
- Version number
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $nestingCount : int
- Counts the nesting level of __call()
- $stringRepresentationBlank : bool
- Whether blank string representations are valid
- $stringRepresentationFields : array<string|int, mixed>
- List of fields that should be available in the string representation
- $stringRepresentationFormat : string
- Sprintf format for the string representation
- $user : User
- The user this value belongs to
- $userId : User
- The user this value belongs to
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $value : string
- The value
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __get() : mixed
- This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
- __toString() : string
- Returns this entity's identifying value
- getAttribute() : UserAttribute
- Returns the associated attribute
- getAttributeId() : UserAttribute
- Returns the associated attribute
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getHistory() : int
- Returns the version ID
- getKeyAsString() : string
- Returns this entity's key
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getUser() : User
- Returns the associated user
- getUserId() : User
- Returns the associated user
- getValue() : string
- Returns the value
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- setAttribute() : mixed
- Sets the associated attribute
- setAttributeId() : mixed
- Sets the associated attribute
- setHistory() : mixed
- Sets the version ID
- setUser() : mixed
- Sets the associated user
- setUserId() : mixed
- Sets the associated user
- setValue() : mixed
- Sets the value
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getStringRepresentationBlank() : bool
- Whether blank string representations are valid
- getStringRepresentationFields() : array<string|int, mixed>
- Returns a list of fields available in the string representation
- getStringRepresentationFormat() : string
- Returns the sprintf() format for the string representation
Properties
$attribute
The attribute this value belongs to
protected
UserAttribute
$attribute
$attributeId
The attribute this value belongs to
protected
UserAttribute
$attributeId
$history
Version number
protected
int
$history
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$user
The user this value belongs to
protected
User
$user
$userId
The user this value belongs to
protected
User
$userId
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$value
The value
protected
string
$value
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Return values
mixed —Return value of the method to call
__get()
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
getAttribute()
Returns the associated attribute
public
getAttribute() : UserAttribute
Return values
UserAttributegetAttributeId()
Returns the associated attribute
public
getAttributeId() : UserAttribute
Return values
UserAttributegetComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetHistory()
Returns the version ID
public
getHistory() : int
Return values
intgetKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
getUser()
Returns the associated user
public
getUser() : User
Return values
UsergetUserId()
Returns the associated user
public
getUserId() : User
Return values
UsergetValue()
Returns the value
public
getValue() : string
Return values
stringinitializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
setAttribute()
Sets the associated attribute
public
setAttribute(UserAttribute $attribute) : mixed
Parameters
- $attribute : UserAttribute
setAttributeId()
Sets the associated attribute
public
setAttributeId(UserAttribute $attribute) : mixed
Parameters
- $attribute : UserAttribute
setHistory()
Sets the version ID
public
setHistory(int $history) : mixed
Parameters
- $history : int
setUser()
Sets the associated user
public
setUser(User $user) : mixed
Parameters
- $user : User
setUserId()
Sets the associated user
public
setUserId(User $user) : mixed
Parameters
- $user : User
setValue()
Sets the value
public
setValue(string $value) : mixed
Parameters
- $value : string
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string