Documentation

FormElement extends HtmlElement
in package

Application

This class provides the magic of being validatable.

Constants

ENCTYPE_MULTIPART_FORMDATA = 'multipart/formdata'

Properties

$cancelUrl : mixed
$addButtons : mixed
$contentModelVoidTags : array<string|int, mixed>
$fieldset : FieldsetElement|null
$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.

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
addChild() : mixed: Add children to first fieldset
addChildren() : mixed
addClass() : mixed
allowDirectClose() : mixed
getAttribute() : mixed
getAttributes() : mixed
getChildren() : mixed
getClasses() : mixed
getComponentController() : SystemComponent: Returns the component controller for this component
getData() : mixed
getKeyAsString() : string: Returns this entity's key
getName() : mixed
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
hasClass() : mixed
initializeValidators() : mixed: Set $this->validators
isValid() : mixed
isVirtual() : bool: Returns the virtuality of the entity
removeClass() : mixed
render() : mixed
setAttribute() : mixed: Sets an attribute
setAttributes() : mixed: Sets a list of attributes
setClass() : mixed
setVirtual() : mixed: Set the virtuality of the entity
unsetAttribute() : mixed: Unsets an attribute
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
setName() : mixed

ENCTYPE_MULTIPART_FORMDATA


    public
        mixed
    ENCTYPE_MULTIPART_FORMDATA
    = 'multipart/formdata'

$cancelUrl


        public
            mixed
    $cancelUrl
     = null

$addButtons


        protected
            mixed
    $addButtons

$contentModelVoidTags


        protected
        static    array<string|int, mixed>
    $contentModelVoidTags
     = array('area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr')

List of element names without content https://www.w3.org/TR/html5/syntax.html#void-elements

$fieldset


        protected
            FieldsetElement|null
    $fieldset
     = null

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

__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 $action[, mixed $method = 'post' ][, mixed $enctype = self::ENCTYPE_MULTIPART_FORMDATA ][, mixed $addButtons = true ]) : mixed

Parameters

$action : mixed
$method : mixed = 'post'
$enctype : mixed = self::ENCTYPE_MULTIPART_FORMDATA
$addButtons : mixed = true

__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

addChild()

Add children to first fieldset


    public
                    addChild(HtmlElement $element[, HtmlElement $reference = null ][, mixed $before = false ][, bool $forceOutsideFieldset = false ]) : mixed

Parameters

$element : HtmlElement
$reference : HtmlElement = null
$before : mixed = false
$forceOutsideFieldset : bool = false

addChildren()


    public
                    addChildren(array<string|int, mixed> $elements[, HtmlElement $reference = null ][, mixed $before = false ]) : mixed

Parameters

$elements : array<string|int, mixed>
$reference : HtmlElement = null
$before : mixed = false

addClass()


    public
                    addClass(mixed $className) : mixed

Parameters

$className : mixed

allowDirectClose()


    public
                    allowDirectClose([mixed $allow = null ]) : mixed

Parameters

$allow : mixed = null

getAttribute()


    public
                    getAttribute(mixed $name) : mixed

Parameters

$name : mixed

getAttributes()


    public
                    getAttributes() : mixed

getChildren()


    public
                    getChildren() : mixed

getClasses()


    public
                    getClasses([mixed &$classes = array() ]) : mixed

Parameters

$classes : mixed = array()

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getData()


    public
                    getData([mixed $element = null ][, mixed &$data = array() ]) : mixed

Parameters

$element : mixed = null
$data : mixed = array()

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


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

hasClass()


    public
                    hasClass(mixed $className) : mixed

Parameters

$className : 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

isValid()


    public
                    isValid() : mixed

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

removeClass()


    public
                    removeClass(mixed $className) : mixed

Parameters

$className : mixed

render()


    public
                    render() : mixed

setAttribute()

Sets an attribute


    public
                    setAttribute(string $name[, string $value = null ]) : mixed

If value is not specified, value will be the same as $name (for cases like checked="checked"). If you want to unset an attribute, use unsetAttribute() or setAttributes(..., true)

Parameters

$name : string: Name of the attribute
$value : string = null: (optional) Value of the attribute

setAttributes()

Sets a list of attributes


    public
                    setAttributes(array<string|int, mixed> $attributes[, bool $removeOthers = false ]) : mixed

Provide an array with attribute name as key and attribute value as value (see setAttribute() for possibilities).

Parameters

$attributes : array<string|int, mixed>: List of attributes to set
$removeOthers : bool = false: Wheter to remove all not specified attributes or not

setClass()


    public
                    setClass(mixed $string) : mixed

Parameters

$string : 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

unsetAttribute()

Unsets an attribute


    public
                    unsetAttribute(string $name) : mixed

Parameters

$name : string: Name of the attribute

validate()


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

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

setName()


    protected
                    setName(mixed $elementName) : mixed

Parameters

$elementName : mixed

FormElement extends HtmlElement in package Application

Table of Contents

Constants

Properties

Methods

Constants

ENCTYPE_MULTIPART_FORMDATA

Properties

$cancelUrl

$addButtons

$contentModelVoidTags

$fieldset

$localeCodes

Tags

$nestingCount

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validators

$virtual

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

addChild()

Parameters

addChildren()

Parameters

addClass()

Parameters

allowDirectClose()

Parameters

getAttribute()

Parameters

getAttributes()

getChildren()

getClasses()

Parameters

getComponentController()

Return values

getData()

Parameters

getKeyAsString()

Parameters

Return values

getName()

getTranslatedFieldValue()

Parameters

hasClass()

Parameters

initializeValidators()

isValid()

isVirtual()

Return values

removeClass()

Parameters

render()

setAttribute()

Parameters

setAttributes()

Parameters

setClass()

Parameters

setVirtual()

Parameters

unsetAttribute()

Parameters

validate()

FormElement extends HtmlElement
in package

Application