Documentation

SystemComponent extends EntityBase
in package

cloudrexx

core

A system component (aka "module", "core_module" or "core component")

Constants

TYPE_CORE = 'core'
TYPE_CORE_MODULE = 'core_module'
TYPE_MODULE = 'module'

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
$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.
$id : int: Unique ID
$name : string: Component name
$type : enum: Component type

Methods

__call() : mixed: Route methods like getName(), getType(), getDirectory(), etc.
__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
getBaseNamespaceForType() : string: Returns the namespace for a component type
getComponentController() : SystemComponent: Returns the component controller for this component
getDirectory() : string: Returns the absolute path to this component's location in the file system
getEntityClasses() : array<string|int, mixed>: Returns a list of entity classes for this component
getId() : int: Get id
getKeyAsString() : string: Returns this entity's key
getName() : string: Get name
getNamespace() : string: Returns the base namespace for this component
getPathForType() : string: Returns the type folder (relative to document root)
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
getType() : enum: Get type
initializeValidators() : mixed: Set $this->validators
isActive() : bool: Checks if the component is active and in the list of legal components (license)
isVirtual() : bool: Returns the virtuality of the entity
setName() : mixed: Set name
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

TYPE_CORE


    public
        mixed
    TYPE_CORE
    = 'core'

TYPE_CORE_MODULE


    public
        mixed
    TYPE_CORE_MODULE
    = 'core_module'

TYPE_MODULE


    public
        mixed
    TYPE_MODULE
    = 'module'

$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

$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

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

$id

Unique ID


        private
            int
    $id

$name

Component name


        private
            string
    $name

$type

Component type


        private
            enum
    $type

__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

__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

getBaseNamespaceForType()

Returns the namespace for a component type


    public
            static        getBaseNamespaceForType(string $type) : string

Parameters

$type : string: Component type name

Return values

string —

Namespace

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getDirectory()

Returns the absolute path to this component's location in the file system


    public
                    getDirectory([bool $allowCustomizing = true ][, bool $relative = false ]) : string

Parameters

$allowCustomizing : bool = true: (optional) Set to false if you want to ignore customizings
$relative : bool = false: (optional) If set to true, the path relative to Cloudrexx main dir is returned, default false

Return values

string —

Path for this component

getEntityClasses()

Returns a list of entity classes for this component


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

Return values

array<string|int, mixed> —

List of class names

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

getName()

Get name


    public
                    getName() : string

Return values

string —

$name

getNamespace()

Returns the base namespace for this component


    public
                    getNamespace() : string

Return values

string —

Namespace

getPathForType()

Returns the type folder (relative to document root)


    public
            static        getPathForType(string $type) : string

Parameters

$type : string: Component type name

Return values

string —

Component type folder relative to document root

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() : enum

Return values

enum —

$type

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

isActive()

Checks if the component is active and in the list of legal components (license)


    public
                    isActive() : bool

Return values

bool —

True if the component is active and legal, false otherwise

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

setName()

Set name


    public
                    setName(string $name) : mixed

Parameters

$name : string

setType()

Set type


    public
                    setType(enum $type) : mixed

Parameters

$type : enum

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

SystemComponent extends EntityBase in package cloudrexx core

Tags

Table of Contents

Constants

Properties

Methods

Constants

TYPE_CORE

TYPE_CORE_MODULE

TYPE_MODULE

Properties

$localeCodes

Tags

$nestingCount

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validators

$virtual

$id

$name

$type

Methods

__call()

Parameters

Tags

Attributes

Return values

__get()

Parameters

Attributes

__toString()

Return values

getBaseNamespaceForType()

Parameters

Tags

Return values

getComponentController()

Return values

getDirectory()

Parameters

Return values

getEntityClasses()

Return values

getId()

Return values

getKeyAsString()

Parameters

Return values

getName()

Return values

getNamespace()

Return values

getPathForType()

Parameters

Tags

Return values

getTranslatedFieldValue()

Parameters

getType()

Return values

initializeValidators()

isActive()

Return values

isVirtual()

Return values

setName()

Parameters

setType()

Parameters

setVirtual()

Parameters

validate()

Tags

getFallbackLocaleCodes()

Tags

Return values

SystemComponent extends EntityBase
in package

cloudrexx

core