Group
extends EntityBase
in package
Cx\Core\User\Model\Entity\Group
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
- $toolbar : string
- $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
- $accessId2 : AccessId
- $groupDescription : string
- $groupId : int
- $groupName : string
- $homepage : string
- $isActive : int
- $type : string
- $user : Collection
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
- addAccessId() : mixed
- Add accessId
- addAccessId2() : mixed
- Add accessId2
- addUser() : mixed
- Add user
- getAccessId() : Collection
- Get accessId
- getAccessId2() : Collection
- Get accessId2
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getGroupDescription() : string
- Get groupDescription
- getGroupId() : int
- Get groupId
- getGroupName() : string
- Get groupName
- getHomepage() : string
- Get homepage
- getIsActive() : int
- Get isActive
- getKeyAsString() : string
- Returns this entity's key
- getToolbar() : string
- Get toolbar
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getType() : string
- Get type
- getUser() : Collection
- Get user
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- removeUser() : mixed
- Remove the User
- setGroupDescription() : mixed
- Set groupDescription
- setGroupName() : mixed
- Set groupName
- setHomepage() : mixed
- Set homepage
- setIsActive() : mixed
- Set isActive
- setToolbar() : mixed
- Set toolbar
- setType() : mixed
- Set type
- 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
$toolbar
protected
string
$toolbar
$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
$accessId2
private
AccessId
$accessId2
$groupDescription
private
string
$groupDescription
$groupId
private
int
$groupId
$groupName
private
string
$groupName
$homepage
private
string
$homepage
$isActive
private
int
$isActive
$type
private
string
$type
$user
private
Collection
$user
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
__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
__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
addAccessId()
Add accessId
public
addAccessId(AccessId $accessId) : mixed
Parameters
- $accessId : AccessId
addAccessId2()
Add accessId2
public
addAccessId2(AccessId $accessId2) : mixed
Parameters
- $accessId2 : AccessId
addUser()
Add user
public
addUser(User $user) : mixed
Parameters
- $user : User
getAccessId()
Get accessId
public
getAccessId() : Collection
Return values
Collection —$accessId
getAccessId2()
Get accessId2
public
getAccessId2() : Collection
Return values
Collection —$accessId2
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetGroupDescription()
Get groupDescription
public
getGroupDescription() : string
Return values
string —$groupDescription
getGroupId()
Get groupId
public
getGroupId() : int
Return values
int —$groupId
getGroupName()
Get groupName
public
getGroupName() : string
Return values
string —$groupName
getHomepage()
Get homepage
public
getHomepage() : string
Return values
string —$homepage
getIsActive()
Get isActive
public
getIsActive() : int
Return values
int —$isActive
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
getToolbar()
Get toolbar
public
getToolbar() : string
Return values
string —$toolbar
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
getType()
Get type
public
getType() : string
Return values
string —$type
getUser()
Get user
public
getUser() : Collection
Return values
Collection —$user
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
removeUser()
Remove the User
public
removeUser(User $user) : mixed
Parameters
- $user : User
setGroupDescription()
Set groupDescription
public
setGroupDescription(string $groupDescription) : mixed
Parameters
- $groupDescription : string
setGroupName()
Set groupName
public
setGroupName(string $groupName) : mixed
Parameters
- $groupName : string
setHomepage()
Set homepage
public
setHomepage(string $homepage) : mixed
Parameters
- $homepage : string
setIsActive()
Set isActive
public
setIsActive(int $isActive) : mixed
Parameters
- $isActive : int
setToolbar()
Set toolbar
public
setToolbar(string $toolbar) : mixed
Parameters
- $toolbar : string
setType()
Set type
public
setType(string $type) : mixed
Parameters
- $type : 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