Documentation

Theme extends WidgetParseTarget
in package

cloudrexx

core

view

Theme

Constants

THEME_COMPONENT_FILE = '/component.yml'
THEME_DEFAULT_PREVIEW_FILE = '/core/Core/View/Media/theme_preview.gif'
THEME_PREVIEW_FILE = '/images/preview.gif'
THEME_TYPE_APP = 'app'
THEME_TYPE_MOBILE = 'mobile'
THEME_TYPE_PDF = 'pdf'
THEME_TYPE_PRINT = 'print'
THEME_TYPE_WEB = 'web'

Properties

$channels : array<string|int, mixed>
$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.
$componentData : mixed
$configurableLibraries : mixed
$db : mixed
$defaults : mixed
$expert : mixed
$foldername : mixed
$id : mixed
$themesname : mixed

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
addDefault() : mixed
getComponentController() : SystemComponent: Returns the component controller for this component
getComponentData() : mixed
getDateTimestamp() : mixed
getDependencies() : array<string|int, mixed>
getDescription() : string
getExpert() : mixed
getExtra() : string
getFilePath() : string: Get the themes file path
getFoldername() : mixed
getId() : mixed
getKeyAsString() : string: Returns this entity's key
getLanguages() : string
getLanguagesByType() : array<string|int, mixed>: Returns the array of active languages of theme by given type
getPreviewImage() : string: Preview image source web path
getPublisher() : string
getReleasedDate() : string
getSubtype() : string
getThemesname() : mixed
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
getVersionNumber() : string
getWidgetContent() : Sigma: Returns the content for a widget
getWidgetContentAttributeName() : string: Dummy, we overwrite getContentTemplateForWidget() directly It is necessary to add this method since it's abstract in the parent class.
initializeValidators() : mixed: Set $this->validators
isComponent() : bool: Checks whether the template is a valid component with component.yml file
isDefault() : bool
isVirtual() : bool: Returns the virtuality of the entity
setComponentData() : mixed
setDependencies() : mixed
setExpert() : mixed
setFoldername() : mixed
setId() : mixed
setThemesname() : mixed
setVirtual() : mixed: Set the virtuality of the entity
validate() : mixed
getContentTemplateForWidget() : Sigma: Returns the template in which the widget can be used
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
sortDependencies() : int: Compares two dependencies so they are loaded in the correct order.

THEME_COMPONENT_FILE


    public
        mixed
    THEME_COMPONENT_FILE
    = '/component.yml'

THEME_DEFAULT_PREVIEW_FILE


    public
        mixed
    THEME_DEFAULT_PREVIEW_FILE
    = '/core/Core/View/Media/theme_preview.gif'

THEME_PREVIEW_FILE


    public
        mixed
    THEME_PREVIEW_FILE
    = '/images/preview.gif'

THEME_TYPE_APP


    public
        mixed
    THEME_TYPE_APP
    = 'app'

THEME_TYPE_MOBILE


    public
        mixed
    THEME_TYPE_MOBILE
    = 'mobile'

THEME_TYPE_PDF


    public
        mixed
    THEME_TYPE_PDF
    = 'pdf'

THEME_TYPE_PRINT


    public
        mixed
    THEME_TYPE_PRINT
    = 'print'

THEME_TYPE_WEB


    public
        mixed
    THEME_TYPE_WEB
    = 'web'

$channels


        public
        static    array<string|int, mixed>
    $channels
     = array(
    'default',
    // web
    self::THEME_TYPE_MOBILE,
    self::THEME_TYPE_PRINT,
    self::THEME_TYPE_PDF,
    self::THEME_TYPE_APP,
)

The channel enum values

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

$componentData


        private
            mixed
    $componentData

$configurableLibraries


        private
            mixed
    $configurableLibraries

$db


        private
            mixed
    $db

$defaults


        private
            mixed
    $defaults
     = array()

$expert


        private
            mixed
    $expert

$foldername


        private
            mixed
    $foldername

$id


        private
            mixed
    $id
     = null

$themesname


        private
            mixed
    $themesname

__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 $id = null ][, mixed $themesname = null ][, mixed $foldername = null ][, mixed $expert = 1 ]) : mixed

Parameters

$id : mixed = null
$themesname : mixed = null
$foldername : mixed = null
$expert : mixed = 1

__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

addDefault()


    public
                    addDefault(mixed $type) : mixed

Parameters

$type : mixed

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getComponentData()


    public
                    getComponentData() : mixed

getDateTimestamp()


    public
                    getDateTimestamp(mixed $date) : mixed

Parameters

$date : mixed

getDependencies()


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

Return values

array<string|int, mixed> —

all dependencies (javascript libraries) which cloudrexx should load when showing this template

getDescription()


    public
                    getDescription() : string

Return values

string —

the description

getExpert()


    public
                    getExpert() : mixed

getExtra()


    public
                    getExtra() : string

Return values

string —

the extra description includes the names of end devices, where the theme is set as default

getFilePath()

Get the themes file path


    public
                    getFilePath(type $filePath) : string

Parameters

$filePath : type

Return values

string

getFoldername()


    public
                    getFoldername() : mixed

getId()


    public
                    getId() : mixed

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

getLanguages()


    public
                    getLanguages() : string

Return values

string —

the language abbreviations of activated languages with this template, separated by comma

getLanguagesByType()

Returns the array of active languages of theme by given type


    public
                    getLanguagesByType(string $type) : array<string|int, mixed>

Parameters

$type : string: the type of output device

Return values

array<string|int, mixed> —

array of languages active for this theme

getPreviewImage()

Preview image source web path


    public
                    getPreviewImage() : string

Return values

string —

the preview image source web path

getPublisher()


    public
                    getPublisher() : string

Return values

string —

the publisher of template

getReleasedDate()


    public
                    getReleasedDate() : string

Return values

string —

the release date of template

getSubtype()


    public
                    getSubtype() : string

Return values

string —

the subtype of the theme

getThemesname()


    public
                    getThemesname() : mixed

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

getVersionNumber()


    public
                    getVersionNumber() : string

Return values

string —

the version number of template

getWidgetContent()

Returns the content for a widget


    public
                    getWidgetContent(string $widgetName, Theme $theme, Page $page, mixed $channel) : Sigma

Parameters

$widgetName : string
$theme : Theme: Theme which is parsed
$page : Page: Page which is parsed
$channel : mixed

Return values

Sigma —

Widget content

getWidgetContentAttributeName()

Dummy, we overwrite getContentTemplateForWidget() directly It is necessary to add this method since it's abstract in the parent class.


    public
                    getWidgetContentAttributeName(mixed $widgetName) : string

Parameters

$widgetName : mixed

Return values

string —

Empty string

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

isComponent()

Checks whether the template is a valid component with component.yml file


    public
                    isComponent() : bool

Return values

bool —

true if a component.yml exists

isDefault()


    public
                    isDefault([string $type = null ]) : bool

Parameters

$type : string = null: the type of end device

Return values

bool —

true if it is set as default, false if not

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

setComponentData()


    public
                    setComponentData(mixed $componentData) : mixed

Parameters

$componentData : mixed

setDependencies()


    public
                    setDependencies([mixed $dependencies = array() ]) : mixed

Parameters

$dependencies : mixed = array()

setExpert()


    public
                    setExpert(mixed $expert) : mixed

Parameters

$expert : mixed

setFoldername()


    public
                    setFoldername(mixed $foldername) : mixed

Parameters

$foldername : mixed

setId()


    public
                    setId(mixed $id) : mixed

Parameters

$id : mixed

setThemesname()


    public
                    setThemesname(mixed $themesname) : mixed

Parameters

$themesname : mixed

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

getContentTemplateForWidget()

Returns the template in which the widget can be used


    protected
                    getContentTemplateForWidget(string $widgetName, int $langId, Page $page, string $channel) : Sigma

Parameters

$widgetName : string: Name of the Widget to get template for
$langId : int: Language ID
$page : Page: Current page
$channel : string: Current channel

Return values

Sigma —

Template which may contain the widget

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

sortDependencies()

Compares two dependencies so they are loaded in the correct order.


    protected
                    sortDependencies(array<string|int, mixed> $a, array<string|int, mixed> $b) : int

Parameters

$a : array<string|int, mixed>: the dependency A
$b : array<string|int, mixed>: the dependency B

Return values

int

Theme extends WidgetParseTarget in package cloudrexx core view

Tags

Table of Contents

Constants

Properties

Methods

Constants

THEME_COMPONENT_FILE

THEME_DEFAULT_PREVIEW_FILE

THEME_PREVIEW_FILE

THEME_TYPE_APP

THEME_TYPE_MOBILE

THEME_TYPE_PDF

THEME_TYPE_PRINT

THEME_TYPE_WEB

Properties

$channels

$localeCodes

Tags

$nestingCount

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validators

$virtual

$componentData

$configurableLibraries

$db

$defaults

$expert

$foldername

$id

$themesname

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

addDefault()

Parameters

getComponentController()

Return values

getComponentData()

getDateTimestamp()

Parameters

getDependencies()

Return values

getDescription()

Return values

getExpert()

getExtra()

Return values

getFilePath()

Parameters

Return values

getFoldername()

getId()

getKeyAsString()

Parameters

Return values

getLanguages()

Return values

getLanguagesByType()

Parameters

Return values

getPreviewImage()

Return values

getPublisher()

Return values

Theme extends WidgetParseTarget
in package

cloudrexx

core

view