Sync
extends EntityBase
in package
Sync
Tags
Table of Contents
Properties
- $active : bool
- $apiKey : string
- $changes : Collection
- $dataAccess : DataAccess
- $hostEntities : Collection
- $id : int
- $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()
- $oldHostEntities : mixed
- $originChanges : Collection
- $relations : Collection
- $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
- $toUri : 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.
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
- addChange() : mixed
- Add change
- addHostEntity() : mixed
- Add hostEntity
- addOriginChange() : Sync
- Add originChanges
- addRelation() : mixed
- Add relation
- calculateRelations() : mixed
- getActive() : bool
- Get active
- getApiKey() : string
- Get apiKey
- getChanges() : Collection
- Get changes
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getDataAccess() : DataAccess
- Get dataAccess
- getHostEntities() : Collection
- Get hostEntities
- getHostEntitiesIncludingLegacy() : mixed
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getOriginChanges() : Collection
- Get originChanges
- getRelatedHosts() : mixed
- getRelations() : Collection
- Get relations
- getToUri() : string
- Get toUri
- 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
- removeChange() : mixed
- Remove changes
- removeHostEntity() : mixed
- Remove hostEntities
- removeOriginChange() : mixed
- Remove originChanges
- removeRelation() : mixed
- Remove relations
- setActive() : mixed
- Set active
- setApiKey() : mixed
- Set apiKey
- setChanges() : mixed
- Set Changes
- setDataAccess() : mixed
- Set dataAccess
- setHostEntities() : mixed
- Set hostEntities
- setOldHostEntitiesIncludingLegacy() : mixed
- setRelations() : mixed
- Set Relations
- setTempActive() : mixed
- setToUri() : mixed
- Set toUri
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- calculateChangeset() : mixed
- calculateContent() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getOldHostEntitiesIncludingLegacy() : mixed
- 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
- isEntityInHostEntity() : mixed
- makeLinkAbsolute() : mixed
Properties
$active
protected
bool
$active
$apiKey
protected
string
$apiKey
$changes
protected
Collection
$changes
$dataAccess
protected
DataAccess
$dataAccess
$hostEntities
protected
Collection
$hostEntities
$id
protected
int
$id
$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
$oldHostEntities
protected
mixed
$oldHostEntities
= array()
$originChanges
protected
Collection
$originChanges
$relations
protected
Collection
$relations
$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
$toUri
protected
string
$toUri
$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
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
addChange()
Add change
public
addChange(Change $change) : mixed
Parameters
- $change : Change
addHostEntity()
Add hostEntity
public
addHostEntity(HostEntity $hostEntity) : mixed
Parameters
- $hostEntity : HostEntity
addOriginChange()
Add originChanges
public
addOriginChange(Change $originChanges) : Sync
Parameters
- $originChanges : Change
Return values
SyncaddRelation()
Add relation
public
addRelation(Relation $relation) : mixed
Parameters
- $relation : Relation
calculateRelations()
public
calculateRelations(mixed $spooler, mixed $eventType, mixed $entityClassName, mixed $entityIndexData, mixed $entity) : mixed
Parameters
- $spooler : mixed
- $eventType : mixed
- $entityClassName : mixed
- $entityIndexData : mixed
- $entity : mixed
getActive()
Get active
public
getActive() : bool
Return values
boolgetApiKey()
Get apiKey
public
getApiKey() : string
Return values
stringgetChanges()
Get changes
public
getChanges() : Collection
Return values
Collection —$changes
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetDataAccess()
Get dataAccess
public
getDataAccess() : DataAccess
Return values
DataAccess —$dataAccess
getHostEntities()
Get hostEntities
public
getHostEntities() : Collection
Return values
Collection —$hostEntities
getHostEntitiesIncludingLegacy()
public
getHostEntitiesIncludingLegacy([mixed $cache = true ][, mixed $host = '' ]) : mixed
Parameters
- $cache : mixed = true
- $host : mixed = ''
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
getOriginChanges()
Get originChanges
public
getOriginChanges() : Collection
Return values
CollectiongetRelatedHosts()
public
getRelatedHosts(mixed $entityIndexData) : mixed
Parameters
- $entityIndexData : mixed
getRelations()
Get relations
public
getRelations() : Collection
Return values
Collection —$relations
getToUri()
Get toUri
public
getToUri([mixed $entityIndexData = array() ]) : string
Parameters
- $entityIndexData : mixed = array()
Return values
stringgetTranslatedFieldValue()
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
removeChange()
Remove changes
public
removeChange(Change $changes) : mixed
Parameters
- $changes : Change
removeHostEntity()
Remove hostEntities
public
removeHostEntity(HostEntity $hostEntities) : mixed
Parameters
- $hostEntities : HostEntity
removeOriginChange()
Remove originChanges
public
removeOriginChange(Change $originChanges) : mixed
Parameters
- $originChanges : Change
removeRelation()
Remove relations
public
removeRelation(Relation $relations) : mixed
Parameters
- $relations : Relation
setActive()
Set active
public
setActive(bool $active) : mixed
Parameters
- $active : bool
setApiKey()
Set apiKey
public
setApiKey(string $apiKey) : mixed
Parameters
- $apiKey : string
setChanges()
Set Changes
public
setChanges(array<string|int, mixed> $changes) : mixed
Parameters
- $changes : array<string|int, mixed>
setDataAccess()
Set dataAccess
public
setDataAccess(DataAccess $dataAccess) : mixed
Parameters
- $dataAccess : DataAccess
setHostEntities()
Set hostEntities
public
setHostEntities(array<string|int, mixed> $hostEntities) : mixed
Parameters
- $hostEntities : array<string|int, mixed>
setOldHostEntitiesIncludingLegacy()
public
setOldHostEntitiesIncludingLegacy(mixed $hostEntities) : mixed
Parameters
- $hostEntities : mixed
setRelations()
Set Relations
public
setRelations(array<string|int, mixed> $relations) : mixed
Parameters
- $relations : array<string|int, mixed>
setTempActive()
public
setTempActive(mixed $tempActive) : mixed
Parameters
- $tempActive : mixed
setToUri()
Set toUri
public
setToUri(string $toUri) : mixed
Parameters
- $toUri : 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
calculateChangeset()
protected
calculateChangeset(mixed $spooler, mixed $eventType, mixed $entityClassName, mixed $entityIndexData, mixed $entity, mixed $changeCondition) : mixed
Parameters
- $spooler : mixed
- $eventType : mixed
- $entityClassName : mixed
- $entityIndexData : mixed
- $entity : mixed
- $changeCondition : mixed
calculateContent()
protected
calculateContent(mixed $change) : mixed
Parameters
- $change : mixed
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
getOldHostEntitiesIncludingLegacy()
protected
getOldHostEntitiesIncludingLegacy() : mixed
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
isEntityInHostEntity()
protected
isEntityInHostEntity(mixed $entityIndexData, mixed $hostEntity) : mixed
Parameters
- $entityIndexData : mixed
- $hostEntity : mixed
makeLinkAbsolute()
protected
makeLinkAbsolute(mixed $input[, mixed $simpleField = false ]) : mixed
Parameters
- $input : mixed
- $simpleField : mixed = false