Relation
extends EntityBase
in package
Relation
Tags
Table of Contents
Properties
- $children : Collection
- $defaultEntityId : int
- $doSync : int
- $foreignDataAccess : DataAccess
- $id : int
- $lft : int
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $localFieldName : string
- $lvl : int
- $nestingCount : int
- Counts the nesting level of __call()
- $parent : Relation
- $relatedSync : Sync
- $rgt : int
- $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.
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
- addChild() : Relation
- Add children
- addChildren() : mixed
- Add children
- getChildren() : Collection
- Get children
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getDefaultEntityId() : int
- Get defaultEntityId
- getDoSync() : int
- Get doSync
- getForeignDataAccess() : DataAccess
- Get foreignDataAccess
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getLft() : int
- Get lft
- getLocalFieldName() : string
- Get localFieldName
- getLvl() : int
- Get lvl
- getParent() : Relation
- Get parent
- getRelatedSync() : Sync
- Get relatedSync
- getRgt() : int
- Get rgt
- 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
- removeChild() : mixed
- Remove children
- setChildren() : mixed
- Set children
- setDefaultEntityId() : mixed
- Set defaultEntityId
- setDoSync() : mixed
- Set doSync
- setForeignDataAccess() : mixed
- Set foreignDataAccess
- setLft() : mixed
- Set lft
- setLocalFieldName() : mixed
- Set localFieldName
- setLvl() : mixed
- Set lvl
- setParent() : mixed
- Set parent
- setRelatedSync() : mixed
- Set relatedSync
- setRgt() : mixed
- Set rgt
- 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
$children
protected
Collection
$children
$defaultEntityId
protected
int
$defaultEntityId
$doSync
protected
int
$doSync
$foreignDataAccess
protected
DataAccess
$foreignDataAccess
$id
protected
int
$id
$lft
protected
int
$lft
$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
$localFieldName
protected
string
$localFieldName
$lvl
protected
int
$lvl
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$parent
protected
Relation
$parent
$relatedSync
protected
Sync
$relatedSync
$rgt
protected
int
$rgt
$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.
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
addChild()
Add children
public
addChild(Relation $children) : Relation
Parameters
- $children : Relation
Return values
RelationaddChildren()
Add children
public
addChildren(Relation $children) : mixed
Parameters
- $children : Relation
getChildren()
Get children
public
getChildren() : Collection
Return values
Collection —$children
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetDefaultEntityId()
Get defaultEntityId
public
getDefaultEntityId() : int
Return values
int —$defaultEntityId
getDoSync()
Get doSync
public
getDoSync() : int
Return values
int —$doSync
getForeignDataAccess()
Get foreignDataAccess
public
getForeignDataAccess() : DataAccess
Return values
DataAccess —$foreignDataAccess
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
getLft()
Get lft
public
getLft() : int
Return values
int —$lft
getLocalFieldName()
Get localFieldName
public
getLocalFieldName() : string
Return values
string —$localFieldName
getLvl()
Get lvl
public
getLvl() : int
Return values
int —$lvl
getParent()
Get parent
public
getParent() : Relation
Return values
Relation —$parent
getRelatedSync()
Get relatedSync
public
getRelatedSync() : Sync
Return values
Sync —$relatedSync
getRgt()
Get rgt
public
getRgt() : int
Return values
int —$rgt
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
removeChild()
Remove children
public
removeChild(Relation $children) : mixed
Parameters
- $children : Relation
setChildren()
Set children
public
setChildren(mixed $children) : mixed
Parameters
- $children : mixed
setDefaultEntityId()
Set defaultEntityId
public
setDefaultEntityId(int $defaultEntityId) : mixed
Parameters
- $defaultEntityId : int
setDoSync()
Set doSync
public
setDoSync(int $doSync) : mixed
Parameters
- $doSync : int
setForeignDataAccess()
Set foreignDataAccess
public
setForeignDataAccess(DataAccess $foreignDataAccess) : mixed
Parameters
- $foreignDataAccess : DataAccess
setLft()
Set lft
public
setLft(int $lft) : mixed
Parameters
- $lft : int
setLocalFieldName()
Set localFieldName
public
setLocalFieldName(string $localFieldName) : mixed
Parameters
- $localFieldName : string
setLvl()
Set lvl
public
setLvl(int $lvl) : mixed
Parameters
- $lvl : int
setParent()
Set parent
public
setParent(Relation $parent) : mixed
Parameters
- $parent : Relation
setRelatedSync()
Set relatedSync
public
setRelatedSync(Sync $relatedSync) : mixed
Parameters
- $relatedSync : Sync
setRgt()
Set rgt
public
setRgt(int $rgt) : mixed
Parameters
- $rgt : int
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