Fuman
\

\Fuman_InputType_Config_Handler

This class handles the process for configurate an class.

Can also be used to create and handle an form.

Summary

Methods
Properties
Constants
__construct()
init()
addElement()
getElement()
hasElement()
removeElement()
removeElements()
filterElements()
getElementName()
getElements()
getRenderElements()
getElementsAsArray()
createElement()
create()
getFormPrefix()
setFormPrefix()
getConfig()
setConfig()
hasAffectedRecord()
getAffectedRecord()
setValuesFromRequest()
setValuesByConfig()
validateConfig()
setElementTemplatePath()
getElementTemplatePath()
hasElementTemplatePath()
No public properties found
No constants found
No protected methods found
$_config
$_configElements
$_renderElementOrder
$_formPrefix
$_affectedRecord
$_elementTemplatePath
N/A
No private methods found
No private properties found
N/A

Properties

$_renderElementOrder

$_renderElementOrder : array

Type

array

$_formPrefix

$_formPrefix : string

Form prefix

Type

string

$_elementTemplatePath

$_elementTemplatePath : string

Type

string

Methods

init()

init() : void

Init Config Handler

addElement()

addElement(string  $key, \Fuman_InputType_Renderer_Abstract  $element, boolean  $isRenderElement = true, null  $insertAtKey = null, boolean  $insertAfter = true) : void

Add element

Parameters

string $key
\Fuman_InputType_Renderer_Abstract $element
boolean $isRenderElement
null $insertAtKey
boolean $insertAfter

hasElement()

hasElement(string  $key) : boolean

Has element

Parameters

string $key

Returns

boolean

removeElement()

removeElement(string  $key) : void

Remove element

Parameters

string $key

removeElements()

removeElements() : void

Removes all elements

filterElements()

filterElements() : void

Removes all config elements which are not in the given arguments list. Used when an inputtype wants to remove certain config elements from the parent inputtype. Added to prevent code duplication of config elements.

getElementName()

getElementName(string  $key) : string

Gets element name for key

Parameters

string $key

Returns

string

getElements()

getElements() : array|\stdClass|array<mixed,\Fuman_InputType_Renderer_Abstract>

Get elements

Returns

array|\stdClass|array<mixed,\Fuman_InputType_Renderer_Abstract>

getRenderElements()

getRenderElements() : \stdClass

Renders elements into stdClass

Returns

\stdClass

getElementsAsArray()

getElementsAsArray(boolean  $onlyRenderingElements = false) : array

Returns the form elements of config. Some elements do have a "not-render" flag, therefore the first argument controls if all elements will be returned or the flagged elements.

Parameters

boolean $onlyRenderingElements

Returns

array

createElement()

createElement(string|null  $translationPrefix, string  $translationKey, string  $elementClassName, array  $validators = array(), boolean  $addElement = true, boolean  $renderElement = true) : \Fuman_InputType_Element

Creates and config element

Parameters

string|null $translationPrefix

(if null, Fuman_Form_Model_Basic will be used as prefix)
string $translationKey
string $elementClassName
array $validators
boolean $addElement
boolean $renderElement

Returns

\Fuman_InputType_Element

create()

create(string  $key, string  $label, \Fuman_Form_Abstract  $formElement, array  $validators = array(), boolean  $addElement = true, boolean  $renderElement = true) : \Fuman_InputType_Element

Create

Parameters

string $key
string $label
\Fuman_Form_Abstract $formElement
array $validators
boolean $addElement
boolean $renderElement

Returns

\Fuman_InputType_Element

getFormPrefix()

getFormPrefix() : string

Gets form prefix

Returns

string

setFormPrefix()

setFormPrefix(string  $formPrefix) : void

Sets form prefix

Parameters

string $formPrefix

setConfig()

setConfig(\Fuman_InputType_Config  $config) : void

Sets config

Parameters

\Fuman_InputType_Config $config

hasAffectedRecord()

hasAffectedRecord() : boolean

Has affected rows

Returns

boolean

getAffectedRecord()

getAffectedRecord() : \Fuman_Db_Record

Gets affected rows

Returns

\Fuman_Db_Record

setValuesFromRequest()

setValuesFromRequest(\Fuman_Request  $request) : void

Sets values from http request

Parameters

\Fuman_Request $request

setValuesByConfig()

setValuesByConfig() : void

Set values from config

validateConfig()

validateConfig() : boolean

Validates the configuration

Returns

boolean

setElementTemplatePath()

setElementTemplatePath(string  $path)

Sets element template path

Parameters

string $path

getElementTemplatePath()

getElementTemplatePath() : string

Gets element template path

Returns

string

hasElementTemplatePath()

hasElementTemplatePath() : boolean

Has element a template path

Returns

boolean