AccessId
extends EntityBase
in package
Cx\Core_Modules\Access\Model\Entity\AccessId
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()
- $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.
- $contrexxAccessUserAttribute : UserAttribute
- $contrexxAccessUserAttributeRead : UserAttribute
- $coreAttribute : CoreAttribute
- $coreAttributeRead : CoreAttribute
- $entity_class_id : string
- $entity_class_name : string
- $group : Group
- $group2 : Group
- $id : int
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __construct() : mixed
- __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
- addContrexxAccessUserAttribute() : mixed
- Add contrexxAccessUserAttribute
- addContrexxAccessUserAttributeRead() : mixed
- Add contrexxAccessUserAttributeRead
- addCoreAttribute() : mixed
- Add coreAttribute
- addCoreAttributeRead() : mixed
- Add coreAttributeRead
- addGroup() : mixed
- Add group
- addGroup2() : mixed
- Add group2
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getContrexxAccessUserAttribute() : Collection
- Get contrexxAccessUserAttribute
- getContrexxAccessUserAttributeRead() : Collection
- Get contrexxAccessUserAttributeRead
- getCoreAttribute() : Collection
- Get coreAttribute
- getCoreAttributeRead() : Collection
- Get coreAttributeRead
- getEntityClassId() : string
- Get entity_class_id
- getEntityClassName() : string
- Get entity_class_name
- getGroup() : Collection
- Get group
- getGroup2() : Collection
- Get group2
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- 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
- setEntityClassId() : mixed
- Set entity_class_id
- setEntityClassName() : mixed
- Set entity_class_name
- 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
$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.
$contrexxAccessUserAttribute
private
UserAttribute
$contrexxAccessUserAttribute
$contrexxAccessUserAttributeRead
private
UserAttribute
$contrexxAccessUserAttributeRead
$coreAttribute
private
CoreAttribute
$coreAttribute
$coreAttributeRead
private
CoreAttribute
$coreAttributeRead
$entity_class_id
private
string
$entity_class_id
$entity_class_name
private
string
$entity_class_name
$group
private
Group
$group
$group2
private
Group
$group2
$id
private
int
$id
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
Attributes
- #[ReturnTypeWillChange]
Return values
mixed —Return value of the method to call
__construct()
public
__construct() : mixed
__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
Attributes
- #[ReturnTypeWillChange]
__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
addContrexxAccessUserAttribute()
Add contrexxAccessUserAttribute
public
addContrexxAccessUserAttribute(UserAttribute $contrexxAccessUserAttribute) : mixed
Parameters
- $contrexxAccessUserAttribute : UserAttribute
addContrexxAccessUserAttributeRead()
Add contrexxAccessUserAttributeRead
public
addContrexxAccessUserAttributeRead(UserAttribute $contrexxAccessUserAttributeRead) : mixed
Parameters
- $contrexxAccessUserAttributeRead : UserAttribute
addCoreAttribute()
Add coreAttribute
public
addCoreAttribute(CoreAttribute $coreAttribute) : mixed
Parameters
- $coreAttribute : CoreAttribute
addCoreAttributeRead()
Add coreAttributeRead
public
addCoreAttributeRead(CoreAttribute $coreAttributeRead) : mixed
Parameters
- $coreAttributeRead : CoreAttribute
addGroup()
Add group
public
addGroup(Group $group) : mixed
Parameters
- $group : Group
addGroup2()
Add group2
public
addGroup2(Group $group2) : mixed
Parameters
- $group2 : Group
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetContrexxAccessUserAttribute()
Get contrexxAccessUserAttribute
public
getContrexxAccessUserAttribute() : Collection
Return values
Collection —$contrexxAccessUserAttribute
getContrexxAccessUserAttributeRead()
Get contrexxAccessUserAttributeRead
public
getContrexxAccessUserAttributeRead() : Collection
Return values
Collection —$contrexxAccessUserAttribute
getCoreAttribute()
Get coreAttribute
public
getCoreAttribute() : Collection
Return values
Collection —$coreAttribute
getCoreAttributeRead()
Get coreAttributeRead
public
getCoreAttributeRead() : Collection
Return values
Collection —$coreAttribute
getEntityClassId()
Get entity_class_id
public
getEntityClassId() : string
Return values
string —$entityClassId
getEntityClassName()
Get entity_class_name
public
getEntityClassName() : string
Return values
string —$entityClassName
getGroup()
Get group
public
getGroup() : Collection
Return values
Collection —$group
getGroup2()
Get group2
public
getGroup2() : Collection
Return values
Collection —$group2
getId()
Get id
public
getId() : int
Return values
int —$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
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
setEntityClassId()
Set entity_class_id
public
setEntityClassId(string $entityClassId) : mixed
Parameters
- $entityClassId : string
setEntityClassName()
Set entity_class_name
public
setEntityClassName(string $entityClassName) : mixed
Parameters
- $entityClassName : 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