Documentation

Host extends EntityBase
in package

cloudrexx

coremodule

sync

Host

Properties

$active : bool
$apiKey : string
$apiVersion : int
$changes : Collection
$defaultUrlTemplate : string
$host : string
$hostEntities : Collection
$id : int
$lastUpdate : DateTime
$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()
$state : 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
$urlTemplate : 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
disable() : mixed
getActive() : bool: Get active
getApiKey() : string: Get apiKey
getApiVersion() : int: Get apiVersion
getChanges() : Collection: Get changes
getComponentController() : SystemComponent: Returns the component controller for this component
getHost() : string: Get host
getHostEntities() : Collection: Get hostEntities
getId() : int: Get id
getKeyAsString() : string: Returns this entity's key
getLastUpdate() : DateTime: Get lastUpdated
getState() : int: Get state
getToUri() : string: Returns the URL for pushing data to this host
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
getUrlTemplate() : string: Get urlTemplate
handleChange() : mixed
initializeValidators() : mixed: Set $this->validators
isLocked() : mixed
isVirtual() : bool: Returns the virtuality of the entity
lock() : mixed
removeChange() : mixed: Remove Change
removeHostEntity() : mixed: Remove hostEntities
removeLock() : mixed
setActive() : mixed: Set active
setApiKey() : mixed: Set apiKey
setApiVersion() : mixed: Set apiVersion
setChanges() : mixed: Set changes
setHost() : mixed: Set host
setHostEntities() : mixed: Set hostEntities
setLastUpdate() : mixed: Set lastUpdated
setState() : mixed: Set state
setUrlTemplate() : mixed: Set urlTemplate
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
sendRequest() : mixed

$active


        protected
            bool
    $active

$apiKey


        protected
            string
    $apiKey

$apiVersion


        protected
            int
    $apiVersion

$changes


        protected
            Collection
    $changes

$defaultUrlTemplate


        protected
            string
    $defaultUrlTemplate
     = '[[HOST]]/api/[[SYNC]]/v[[API_VERSION]]/json/[[DATA_SOURCE]]/[[INDEX_DATA]]?apikey=[[API_KEY]]'

Default template for URI

$host


        protected
            string
    $host

$hostEntities


        protected
            Collection
    $hostEntities

$id


        protected
            int
    $id

$lastUpdate


        protected
            DateTime
    $lastUpdate

$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

$state


        protected
            int
    $state

$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

$urlTemplate


        protected
            string
    $urlTemplate

$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()


    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

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

disable()


    public
                    disable() : mixed

getActive()

Get active


    public
                    getActive() : bool

Return values

bool —

$active

getApiKey()

Get apiKey


    public
                    getApiKey() : string

Return values

string —

$apiKey

getApiVersion()

Get apiVersion


    public
                    getApiVersion() : int

Return values

int —

$apiVersion

getChanges()

Get changes


    public
                    getChanges() : Collection

Return values

Collection —

$changes

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getHost()

Get host


    public
                    getHost() : string

Return values

string —

$host

getHostEntities()

Get hostEntities


    public
                    getHostEntities() : Collection

Return values

Collection —

$hostEntities

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

getLastUpdate()

Get lastUpdated


    public
                    getLastUpdate() : DateTime

Return values

DateTime —

$lastUpdated

getState()

Get state


    public
                    getState() : int

Return values

int —

$state

getToUri()

Returns the URL for pushing data to this host


    public
                    getToUri(mixed $dataAccess[, array<string|int, mixed> $entityIndexData = array() ]) : string

Parameters

$dataAccess : mixed
$entityIndexData : array<string|int, mixed> = array(): (optional) Field=>Value-type array with entity index data

Return values

string —

URL to push to

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

getUrlTemplate()

Get urlTemplate


    public
                    getUrlTemplate() : string

Return values

string —

$urlTemplate

handleChange()


    public
                    handleChange(mixed $change) : mixed

Parameters

$change : mixed

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

isLocked()


    public
                    isLocked() : mixed

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

lock()


    public
                    lock() : mixed

removeChange()

Remove Change


    public
                    removeChange(Change $change) : mixed

Parameters

$change : Change

removeHostEntity()

Remove hostEntities


    public
                    removeHostEntity(HostEntity $hostEntities) : mixed

Parameters

$hostEntities : HostEntity

removeLock()


    public
                    removeLock() : mixed

setActive()

Set active


    public
                    setActive(bool $active) : mixed

Parameters

$active : bool

setApiKey()

Set apiKey


    public
                    setApiKey(string $apiKey) : mixed

Parameters

$apiKey : string

setApiVersion()

Set apiVersion


    public
                    setApiVersion(int $apiVersion) : mixed

Parameters

$apiVersion : int

setChanges()

Set changes


    public
                    setChanges(array<string|int, mixed> $changes) : mixed

Parameters

$changes : array<string|int, mixed>

setHost()

Set host


    public
                    setHost(string $host) : mixed

Parameters

$host : string

setHostEntities()

Set hostEntities


    public
                    setHostEntities(array<string|int, mixed> $hostEntities) : mixed

Parameters

$hostEntities : array<string|int, mixed>

setLastUpdate()

Set lastUpdated


    public
                    setLastUpdate(mixed $lastUpdate) : mixed

Parameters

$lastUpdate : mixed

setState()

Set state


    public
                    setState(int $state) : mixed

Parameters

$state : int

setUrlTemplate()

Set urlTemplate


    public
                    setUrlTemplate(string $urlTemplate) : mixed

Parameters

$urlTemplate : 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

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

sendRequest()


    protected
                    sendRequest(mixed $content, mixed $entityIndexData, mixed $eventType, mixed $sync) : mixed

Parameters

$content : mixed
$entityIndexData : mixed
$eventType : mixed
$sync : mixed

Host extends EntityBase in package cloudrexx coremodule sync

Tags

Table of Contents

Properties

Methods

Properties

$active

$apiKey

$apiVersion

$changes

$defaultUrlTemplate

$host

$hostEntities

$id

$lastUpdate

$localeCodes

Tags

$nestingCount

$state

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$urlTemplate

$validators

$virtual

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

__get()

Parameters

Attributes

__toString()

Return values

addChange()

Parameters

addHostEntity()

Parameters

disable()

getActive()

Return values

getApiKey()

Return values

getApiVersion()

Return values

getChanges()

Return values

getComponentController()

Return values

getHost()

Return values

getHostEntities()

Return values

getId()

Return values

getKeyAsString()

Parameters

Return values

getLastUpdate()

Return values

getState()

Return values

getToUri()

Parameters

Return values

getTranslatedFieldValue()

Parameters

getUrlTemplate()

Return values

handleChange()

Parameters

initializeValidators()

isLocked()

isVirtual()

Host extends EntityBase
in package

cloudrexx

coremodule

sync