Documentation

OptionSet extends EntityBase
in package
implements YamlSerializable

Class ThemeOptions

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

Robin Glauser robin.glauser@cloudrexx.com

subpackage

core_module_templateeditor

Table of Contents

Interfaces

YamlSerializable
Class YamlSerializable

Properties

$activePreset  : Preset
Active preset for frontend
$appliedPreset  : Preset
$data  : array<string|int, mixed>
Unmodified data of options.yml
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$name  : mixed
$nestingCount  : int
Counts the nesting level of __call()
$options  : array<string|int, Option>
$presetRepository  : PresetRepository
$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
$theme  : Theme
The associated theme to the option set.
$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
applyPreset()  : mixed
Apply a preset
getActivePreset()  : Preset
Get the active preset
getChangedPreset()  : Preset
Get the changed preset.
getComponentController()  : SystemComponent
Returns the component controller for this component
getKeyAsString()  : string
Returns this entity's key
getName()  : mixed
Get a name
getOption()  : Option
Get a option
getOptionCount()  : int
Get option count
getPresetRepository()  : PresetRepository
Get the presetrepository
getPresets()  : array<string|int, mixed>
Get list of presets
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
handleChanges()  : array<string|int, mixed>
Pass the changes to the option directly to handle it.
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
renderOptions()  : mixed
Call the renderBackend method on all child options.
renderTheme()  : mixed
Call the renderFrontend method on all child options.
setActivePreset()  : mixed
Set the active preset.
setName()  : mixed
Set a name
setOption()  : mixed
Set a option
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
yamlSerialize()  : array<string|int, mixed>
Serialize a class to use in a .yml file.
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

Properties

$data

Unmodified data of options.yml

protected array<string|int, mixed> $data

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

$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

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

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

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$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
throws
Exception

If __call() nesting level reaches 20

Attributes
#[ReturnTypeWillChange]
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
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

applyPreset()

Apply a preset

public applyPreset(Preset $preset[, bool $raiseIssues = false ]) : mixed
Parameters
$preset : Preset
$raiseIssues : bool = false

Set to true to generate user error messages.

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

getOptionCount()

Get option count

public getOptionCount() : int
Return values
int

getPresets()

Get list of presets

public getPresets() : array<string|int, mixed>
Return values
array<string|int, 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

handleChanges()

Pass the changes to the option directly to handle it.

public handleChanges(mixed $name, mixed $data) : array<string|int, mixed>

It returns the data which should be saved into the session.

Parameters
$name : mixed
$data : mixed
Tags
throws
ThemeOptionNotFoundException
Return values
array<string|int, 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

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

renderOptions()

Call the renderBackend method on all child options.

public renderOptions(Sigma $template) : mixed
Parameters
$template : Sigma

renderTheme()

Call the renderFrontend method on all child options.

public renderTheme(Sigma $template) : mixed
Parameters
$template : Sigma

setName()

Set a name

public setName(mixed $name) : mixed
Parameters
$name : mixed

setOption()

Set a option

public setOption(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : 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

yamlSerialize()

Serialize a class to use in a .yml file.

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

This should return a array which will be serialized by the caller.

Return values
array<string|int, 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
todo

Order the array by the fallback order (same as in ContentManager)

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results