Documentation

YamlSetting extends YamlEntity
in package

YamlSetting Entity

A entity that represents a YamlSetting.

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

Thomas Däppen thomas.daeppen@comvation.com

subpackage

core_setting

Table of Contents

Properties

$group  : string
YamlSetting's group name
$id  : int
Primary identifier of the YamlSetting
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$name  : string
Setting name of the YamlSetting
$nestingCount  : int
Counts the nesting level of __call()
$ord  : int
YamlSetting's order number
$section  : string
YamlSetting's section name
$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
$type  : string
YamlSetting's type
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$value  : string
YamlSetting's default value
$values  : string
YamlSetting's values
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed
Route methods like getName(), getType(), getDirectory(), etc.
__construct()  : mixed
Constructor to initialize a new YamlSetting.
__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
getComponentController()  : SystemComponent
Returns the component controller for this component
getGroup()  : string
Return the group name
getId()  : int
Return primary identifier of YamlSetting
getKeyAsString()  : string
Returns this entity's key
getName()  : string
Return the YamlSetting name
getOrd()  : string
Return the setting's order
getSection()  : string
Return the section name
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
getType()  : string
Return the setting's type
getValue()  : string
Return the setting's value
getValues()  : string
Return the setting's values
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
setGroup()  : mixed
Set the group name
setId()  : mixed
Set primary identifier of YamlSetting
setName()  : mixed
Set a YamlSetting name
setOrd()  : mixed
Set the setting's order
setSection()  : mixed
Set the section name
setType()  : mixed
Set the setting's type
setValue()  : mixed
Set the setting's value
setValues()  : mixed
Set the settings values
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

Properties

$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

__construct()

Constructor to initialize a new YamlSetting.

public __construct(string $name) : mixed
Parameters
$name : string

Setting name of the YamlSetting

__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

getGroup()

Return the group name

public getGroup() : string
Return values
string —

$group

getId()

Return primary identifier of YamlSetting

public getId() : int
Return values
int —

Primary identifier of YamlSetting

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

Return the YamlSetting name

public getName() : string
Return values
string —

name of YamlSetting name

getOrd()

Return the setting's order

public getOrd() : string
Return values
string

getSection()

Return the section name

public getSection() : string
Return values
string —

$section

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

Return the setting's type

public getType() : string
Return values
string —

$type

getValue()

Return the setting's value

public getValue() : string
Return values
string —

$value

getValues()

Return the setting's values

public getValues() : string
Return values
string —

$values

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

setGroup()

Set the group name

public setGroup(string $group) : mixed
Parameters
$group : string

setId()

Set primary identifier of YamlSetting

public setId(int $id) : mixed
Parameters
$id : int

Primary identifier for YamlSetting

setName()

Set a YamlSetting name

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

YamlSetting name

setOrd()

Set the setting's order

public setOrd(int $ord) : mixed
Parameters
$ord : int

setSection()

Set the section name

public setSection(string $section) : mixed
Parameters
$section : string

setType()

Set the setting's type

public setType(string $type) : mixed
Parameters
$type : string

setValue()

Set the setting's value

public setValue(string $value) : mixed
Parameters
$value : string

setValues()

Set the settings values

public setValues(string $values) : mixed
Parameters
$values : 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

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