Documentation

ColorOption extends Option
in package

Class ColorOption

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

Robin Glauser robin.glauser@cloudrexx.com

subpackage

core_module_templateeditor

Table of Contents

Constants

CSS_COLOR_REGEX  = '/^(#([0-9a-f]{3}){1,2}|(rgba|hsla)\\(\\d{1,3}%?(,\\s?\\d{1,3}%?){2},\\s?(1(?:\\.0)?|0|0?\\.\\d+)\\)|(rgb|hsl)\\(\\d{1,3}%?(,\\s?\\d{1,3}%?){2}\\))$/i'
RegEx for CSS colors Based on https://gist.github.com/olmokramer/82ccce673f86db7cda5e

Properties

$choice  : array<string|int, mixed>
Array with color choices in hex format
$color  : string
Color in hex format
$humanName  : string
The translated name of the option. If the active language isn't available english is used as a fallback. If this also isn't available the name of the option is used.
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$name  : void
The identifying name of the option.
$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
$translations  : array<string|int, mixed>
Array with translations for all available languages.
$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
adjustBrightness()  : string
Adjust the brightness of a hex color
getColor()  : mixed
Get the color
getComponentController()  : SystemComponent
Returns the component controller for this component
getHumanName()  : string
Get the translated name of the option
getKeyAsString()  : string
Returns this entity's key
getName()  : string
Get the name of the option.
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
getValue()  : array<string|int, mixed>
Gets the current value of the option.
handleChange()  : array<string|int, mixed>
Handle a change of the option.
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
renderOptionField()  : mixed
Render the option field in the backend.
renderTheme()  : mixed
Render the option in the frontend.
setColor()  : mixed
Set the color
setHumanName()  : mixed
Set the human name.
setName()  : mixed
Set the name of the option.
setVirtual()  : mixed
Set the virtuality of the entity
validate()  : mixed
yamlSerialize()  : array<string|int, mixed>
Get the data in a serializable format.
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

Constants

CSS_COLOR_REGEX

RegEx for CSS colors Based on https://gist.github.com/olmokramer/82ccce673f86db7cda5e

public string CSS_COLOR_REGEX = '/^(#([0-9a-f]{3}){1,2}|(rgba|hsla)\\(\\d{1,3}%?(,\\s?\\d{1,3}%?){2},\\s?(1(?:\\.0)?|0|0?\\.\\d+)\\)|(rgb|hsl)\\(\\d{1,3}%?(,\\s?\\d{1,3}%?){2}\\))$/i'

Properties

$choice

Array with color choices in hex format

protected array<string|int, mixed> $choice

$humanName

The translated name of the option. If the active language isn't available english is used as a fallback. If this also isn't available the name of the option is used.

protected string $humanName

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

$name

The identifying name of the option.

protected void $name

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

$translations

Array with translations for all available languages.

protected array<string|int, mixed> $translations

The key of the array is the language id.

$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

Return values
mixed —

Return value of the method to call

__construct()

public __construct(string $name, array<string|int, mixed> $translations, array<string|int, mixed> $data) : mixed
Parameters
$name : string

Name of the option

$translations : array<string|int, mixed>

Array with translations for option.

$data : array<string|int, 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

__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

adjustBrightness()

Adjust the brightness of a hex color

public adjustBrightness( $hex,  $steps) : string
Parameters
$hex :
$steps :
Return values
string

getHumanName()

Get the translated name of the option

public getHumanName() : string
Return values
string

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 the name of the option.

public getName() : string
Return values
string

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

getValue()

Gets the current value of the option.

public getValue() : array<string|int, mixed>
Return values
array<string|int, mixed>

handleChange()

Handle a change of the option.

public handleChange(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Data from frontend javascript

Tags
throws
OptionValueNotValidException

If the data which the option should handle is invalid this exception will be thrown. It gets caught by the JsonData class and gets handled by the javascript callback in the frontend.

Return values
array<string|int, mixed> —

Changed data for the frontend javascript

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

renderOptionField()

Render the option field in the backend.

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

setColor()

Set the color

public setColor(mixed $color) : mixed
Parameters
$color : mixed

setHumanName()

Set the human name.

public setHumanName(string $humanName) : mixed
Parameters
$humanName : string

setName()

Set the name of the option.

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

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

Get the data in a serializable format.

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