Documentation

Setting extends EntityBase
in package

This class provides the magic of being validatable.

Tags
copyright

Cloudrexx AG

author

Michael Ritter michael.ritter@cloudrexx.com

subpackage

core_setting Setting

Table of Contents

Properties

$group  : string
$id  : int
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$name  : string
$nestingCount  : int
Counts the nesting level of __call()
$ord  : int
$section  : string
$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
$userBased  : bool
$userValues  : Collection
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$value  : string
$values  : string
$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
__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
addUserValue()  : Setting
Add userValues
getComponentController()  : SystemComponent
Returns the component controller for this component
getGroup()  : string
Get group
getId()  : int
Get id
getKeyAsString()  : string
Returns this entity's key
getName()  : string
Get name
getOrd()  : int
Get ord
getSection()  : string
Get section
getTranslatedFieldValue()  : mixed
Returns the value of a translatable field using fallback mechanisms
getType()  : string
Get type
getUserBased()  : bool
Get userBased
getUserValues()  : Collection
Get userValues
getValue()  : string
Get value
getValues()  : string
Get values
initializeValidators()  : mixed
Set $this->validators
isVirtual()  : bool
Returns the virtuality of the entity
removeUserValue()  : mixed
Remove userValues
setGroup()  : Setting
Set group
setName()  : Setting
Set name
setOrd()  : Setting
Set ord
setSection()  : Setting
Set section
setType()  : Setting
Set type
setUserBased()  : Setting
Set userBased
setValue()  : Setting
Set value
setValues()  : Setting
Set values
setVirtual()  : mixed
Set the virtuality of the entity
toArray()  : array<string|int, mixed>
Returns the data of this entity as an array
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
getValidatorForValuesField()  : CxValidate
Returns the validator for the type of this setting
getValuesAsArray()  : array<string|int, mixed>
Returns $this->values as a parsed array

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

public __construct([string $section = '' ][, string $group = '' ][, string $name = '' ][, string $type = 'text' ][, string $value = '' ][, string $values = '' ][, int $ord = 0 ]) : mixed
Parameters
$section : string = ''
$group : string = ''
$name : string = ''
$type : string = 'text'
$value : string = ''
$values : string = ''
$ord : int = 0

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

Get group

public getGroup() : 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 name

public getName() : string
Return values
string

getSection()

Get section

public getSection() : 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

getType()

Get type

public getType() : string
Return values
string

getUserBased()

Get userBased

public getUserBased() : bool
Return values
bool

getUserValues()

Get userValues

public getUserValues() : Collection
Return values
Collection

getValue()

Get value

public getValue() : string
Return values
string

getValues()

Get values

public getValues() : string
Return values
string

initializeValidators()

Set $this->validators

public initializeValidators() : mixed

isVirtual()

Returns the virtuality of the entity

public isVirtual() : bool
Return values
bool —

TRUE if the entity is virtual, otherwise FALSE

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

toArray()

Returns the data of this entity as an array

public toArray() : array<string|int, mixed>
Tags
todo:

This should be solved in EntityBase

Return values
array<string|int, mixed> —

Simple key=>value array of all fields of this entity

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

getValidatorForValuesField()

Returns the validator for the type of this setting

protected getValidatorForValuesField() : CxValidate
Tags
todo

Add support for currently unsupported types

throws
Exception

If the field type is not (yet) supported

Return values
CxValidate —

Validate instance

getValuesAsArray()

Returns $this->values as a parsed array

protected getValuesAsArray() : array<string|int, mixed>

$this->values is one of the following:

  1. A callback which returns an array
  2. A comma separated list
  3. A single value Whether it's 1/2 or 3 can only be determined using the type To check whether it's 1 or 2 we can use preg_match()
Tags
todo

Add support for currently unsupported types

Return values
array<string|int, mixed> —

List of valid values


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results