Documentation

Change extends EntityBase
in package

cloudrexx

coremodule

sync

Host

Properties

$condition : string
$contents : array<string|int, mixed>
$entity : EntityBase
$entityIndexData : array<string|int, mixed>
$eventType : string
$hosts : 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()
$originEntityIndexData : array<string|int, mixed>
$originSync : Sync
$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
$sync : Sync
$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: Create a new change object
__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
addHost() : mixed: Adds a related Host object
getComponentController() : SystemComponent: Returns the component controller for this component
getCondition() : string: Gets condition
getContents() : array<string|int, mixed>: Gets request contents
getEntity() : EntityBase: Gets related entity
getEntityIndexData() : array<string|int, mixed>: Gets related entity's index data
getEventType() : string: Gets event type
getHosts() : array<string|int, mixed>: Gets related Host objects
getId() : int: Gets ID
getKeyAsString() : string: Returns this entity's key
getOriginEntityIndexData() : array<string|int, mixed>: Gets origin entity's index data
getOriginSync() : Sync: Gets origin sync object
getSync() : Sync: Gets related sync object
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
removeHost() : mixed: Removes a related Host object
setCondition() : mixed: Sets condition
setContents() : mixed: Sets request contents
setEntity() : mixed: Sets related entity
setEntityIndexData() : mixed: Sets related entity's index data
setEventType() : mixed: Sets event type
setHosts() : mixed: Sets related Host objects
setId() : mixed: Sets ID
setMode() : bool: Sets change mode
setOriginEntityIndexData() : mixed: Sets origin entity's index data
setOriginSync() : mixed: Sets origin sync object
setSync() : mixed: Sets related sync object
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

$condition


        protected
            string
    $condition

One of "delete", "forward", "both"

$contents


        protected
            array<string|int, mixed>
    $contents
     = array()

Field=>value type array

$entity


        protected
            EntityBase
    $entity
     = null

$entityIndexData


        protected
            array<string|int, mixed>
    $entityIndexData

$eventType


        protected
            string
    $eventType

One of "delete", "put", "post"

$hosts


        protected
            Collection
    $hosts

$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>, ...))

$nestingCount

Counts the nesting level of __call()


        protected
        static    int
    $nestingCount
     = 0

$originEntityIndexData


        protected
            array<string|int, mixed>
    $originEntityIndexData

$originSync


        protected
            Sync
    $originSync

$stringRepresentationBlank

Whether blank string representations are valid


        protected
            bool
    $stringRepresentationBlank
     = false

Whether blank string representations are valid

$stringRepresentationFields

List of fields that should be available in the string representation


        protected
            array<string|int, mixed>
    $stringRepresentationFields
     = array()

List of field names

$stringRepresentationFormat

Sprintf format for the string representation


        protected
            string
    $stringRepresentationFormat
     = ''

Sprintf format string

$sync


        protected
            Sync
    $sync

$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.

__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

Return values

mixed —

Return value of the method to call

__construct()

Create a new change object


    public
                    __construct(Sync $sync, string $eventType, mixed $condition, array<string|int, mixed> $entityIndexData, Sync $originSync, string $originEntityIndexData, array<string|int, mixed>|EntityBase $entityOrContents) : mixed

Parameters

$sync : Sync: Related sync object
$eventType : string: One of "delete", "put", "post"
$condition : mixed
$entityIndexData : array<string|int, mixed>: Related entity's index data
$originSync : Sync: Origin sync object
$originEntityIndexData : string: Origin entity's index data
$entityOrContents : array<string|int, mixed>|EntityBase: Related entity or Field=>value type array of contents

__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

#[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

addHost()

Adds a related Host object


    public
                    addHost(Host $host) : mixed

Parameters

$host : Host: New Host

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getCondition()

Gets condition


    public
                    getCondition() : string

Return values

string —

One of "delete", "forward", "both"

getContents()

Gets request contents


    public
                    getContents() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Field=>value type array

getEntity()

Gets related entity


    public
                    getEntity() : EntityBase

Return values

EntityBase —

Related entity

getEntityIndexData()

Gets related entity's index data


    public
                    getEntityIndexData() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Entity index data

getEventType()

Gets event type


    public
                    getEventType() : string

Return values

string —

One of "delete", "put", "post"

getHosts()

Gets related Host objects


    public
                    getHosts() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Related Hosts

getId()

Gets ID


    public
                    getId() : int

Return values

int —

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

getOriginEntityIndexData()

Gets origin entity's index data


    public
                    getOriginEntityIndexData() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Origin entity's index data

getOriginSync()

Gets origin sync object


    public
                    getOriginSync() : Sync

Return values

Sync —

Origin sync

getSync()

Gets related sync object


    public
                    getSync() : Sync

Return values

Sync —

Related sync

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

removeHost()

Removes a related Host object


    public
                    removeHost(Host $host) : mixed

Parameters

$host : Host: Host to remove

setCondition()

Sets condition


    public
                    setCondition(string $condition) : mixed

Parameters

$condition : string: One of "delete", "forward", "both"

setContents()

Sets request contents


    public
                    setContents(array<string|int, mixed> $contents) : mixed

Parameters

$contents : array<string|int, mixed>: Field=>value type array

setEntity()

Sets related entity


    public
                    setEntity(EntityBase $entity) : mixed

Parameters

$entity : EntityBase: New entity

setEntityIndexData()

Sets related entity's index data


    public
                    setEntityIndexData(array<string|int, mixed> $entityIndexData) : mixed

Parameters

$entityIndexData : array<string|int, mixed>: Entity index data

setEventType()

Sets event type


    public
                    setEventType(string $eventType) : mixed

Parameters

$eventType : string: One of "delete", "put", "post"

setHosts()

Sets related Host objects


    public
                    setHosts(array<string|int, mixed> $hosts) : mixed

Parameters

$hosts : array<string|int, mixed>: New Hosts

setId()

Sets ID


    public
                    setId(int $id) : mixed

Parameters

$id : int: New ID

setMode()

Sets change mode


    public
                    setMode(string $hostEventType) : bool

Parameters

$hostEventType : string: Either "forward" or "delete"

Return values

bool —

Wheter this change is to be applied in this mode or not

setOriginEntityIndexData()

Sets origin entity's index data


    public
                    setOriginEntityIndexData(array<string|int, mixed> $originEntityIndexData) : mixed

Parameters

$originEntityIndexData : array<string|int, mixed>: Origin entity's index data

setOriginSync()

Sets origin sync object


    public
                    setOriginSync(Sync $originSync) : mixed

Parameters

$originSync : Sync: New sync

setSync()

Sets related sync object


    public
                    setSync(Sync $sync) : mixed

Parameters

$sync : Sync: New sync

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

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)

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

Change extends EntityBase in package cloudrexx coremodule sync

Tags

Table of Contents

Properties

Methods

Properties

$condition

$contents

$entity

$entityIndexData

$eventType

$hosts

$id

$localeCodes

Tags

$nestingCount

$originEntityIndexData

$originSync

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$sync

$validators

$virtual

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

addHost()

Parameters

getComponentController()

Return values

getCondition()

Return values

getContents()

Return values

getEntity()

Return values

getEntityIndexData()

Return values

getEventType()

Return values

getHosts()

Return values

getId()

Return values

getKeyAsString()

Parameters

Return values

getOriginEntityIndexData()

Return values

getOriginSync()

Return values

getSync()

Return values

getTranslatedFieldValue()

Parameters

initializeValidators()

isVirtual()

Return values

removeHost()

Parameters

setCondition()

Parameters

setContents()

Parameters

setEntity()

Parameters

Change extends EntityBase
in package

cloudrexx

coremodule

sync