CoreAttribute
extends EntityBase
in package
Cx\Core\User\Model\Entity\CoreAttribute
Table of Contents
Properties
- $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()
- $readAccessId : AccessId
- $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
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
- $accessId : AccessId
- $accessSpecial : string
- $id : string
- $mandatory : string
- $orderId : int
- $sortType : string
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
- getAccessId() : AccessId
- Get accessId
- getAccessSpecial() : string
- Get accessSpecial
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getId() : string
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getMandatory() : string
- Get mandatory
- getOrderId() : int
- Get orderId
- getReadAccessId() : AccessId
- Get readAccessId
- getSortType() : string
- Get sortType
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- setAccessId() : mixed
- Set accessId
- setAccessSpecial() : mixed
- Set accessSpecial
- setId() : mixed
- Set id
- setMandatory() : mixed
- Set mandatory
- setOrderId() : mixed
- Set orderId
- setReadAccessId() : mixed
- Set readAccessId
- setSortType() : mixed
- Set sortType
- 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
$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
$readAccessId
protected
AccessId
$readAccessId
$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
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
$accessId
private
AccessId
$accessId
$accessSpecial
private
string
$accessSpecial
$id
private
string
$id
$mandatory
private
string
$mandatory
$orderId
private
int
$orderId
$sortType
private
string
$sortType
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
getAccessId()
Get accessId
public
getAccessId() : AccessId
Return values
AccessId —$accessId
getAccessSpecial()
Get accessSpecial
public
getAccessSpecial() : string
Return values
string —$accessSpecial
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetId()
Get id
public
getId() : string
Return values
string —$id
getKeyAsString()
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
getMandatory()
Get mandatory
public
getMandatory() : string
Return values
string —$mandatory
getOrderId()
Get orderId
public
getOrderId() : int
Return values
int —$orderId
getReadAccessId()
Get readAccessId
public
getReadAccessId() : AccessId
Return values
AccessId —$readAccessId
getSortType()
Get sortType
public
getSortType() : string
Return values
string —$sortType
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
initializeValidators()
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
setAccessId()
Set accessId
public
setAccessId(AccessId $accessId) : mixed
Parameters
- $accessId : AccessId
setAccessSpecial()
Set accessSpecial
public
setAccessSpecial(string $accessSpecial) : mixed
Parameters
- $accessSpecial : string
setId()
Set id
public
setId(string $id) : mixed
Parameters
- $id : string
setMandatory()
Set mandatory
public
setMandatory(string $mandatory) : mixed
Parameters
- $mandatory : string
setOrderId()
Set orderId
public
setOrderId(int $orderId) : mixed
Parameters
- $orderId : int
setReadAccessId()
Set readAccessId
public
setReadAccessId(AccessId $readAccessId) : mixed
Parameters
- $readAccessId : AccessId
setSortType()
Set sortType
public
setSortType(string $sortType) : mixed
Parameters
- $sortType : 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