Fuman
\

\Fuman_Form_Model_Basic

Form model

Summary

Methods
Properties
Constants
getKey()
getElements()
getElementsForRendering()
initByRequest()
init()
validate()
save()
hasElementValidationErrors()
getValidationErrorsForElement()
getHandler()
setHandler()
hasHandler()
getTranslationLanguage()
hasTranslationLanguage()
setTranslationLanguage()
__construct()
getElement()
hasElement()
removeElement()
removeElements()
getValues()
resetValues()
setValues()
getValidators()
addValidator()
addValidationError()
getValidationErrors()
hasElementValidators()
getValidatorsForElement()
resetValidators()
resetValidationErrors()
resetElements()
getFormPrefix()
setFormPrefix()
setTranslationPrefix()
getTranslationPrefix()
getTranslationPrefixAddOn()
setTranslationPrefixAddOn()
setTranslationKeyStrings()
getElementName()
addElement()
create()
createElement()
getLabel()
initValues()
getAffectedRecord()
setAffectedRecord()
No public properties found
No constants found
No protected methods found
$_elements
$_handler
$_translationLanguage
$_translationPrefix
$_translationPrefixAddOn
$_formPrefix
$_values
$_defaultValues
$_renderElements
$_validators
$_errorMessages
$_validationErrors
$_hasValidationError
$_affectedRecord
$_key
N/A
No private methods found
No private properties found
N/A

Properties

$_translationLanguage

$_translationLanguage : string

Type

string

$_translationPrefix

$_translationPrefix : string

Type

string

$_translationPrefixAddOn

$_translationPrefixAddOn : string

Type

string

$_formPrefix

$_formPrefix : string

Type

string

$_values

$_values : \stdClass;

Type

\stdClass;

$_defaultValues

$_defaultValues : \stdClass

Type

\stdClass

$_renderElements

$_renderElements : \stdClass

Type

\stdClass

$_errorMessages

$_errorMessages : array

Type

array

$_validationErrors

$_validationErrors : array

Type

array

$_hasValidationError

$_hasValidationError : boolean

Type

boolean

$_key

$_key : string

Type

string

Methods

getKey()

getKey() : string

Gets key

Returns

string

getElementsForRendering()

getElementsForRendering() : \Fuman_Response_Data

Gets elements for rendering

Returns

\Fuman_Response_Data

initByRequest()

initByRequest(\Fuman_Request  $request) : void

Init by request

Parameters

\Fuman_Request $request

init()

init() : void

Init

validate()

validate() : boolean

Valdiate

Returns

boolean

save()

save() : boolean

Save

Returns

boolean

hasElementValidationErrors()

hasElementValidationErrors(string  $key) : boolean

Has element validation errors

Parameters

string $key

Returns

boolean

getValidationErrorsForElement()

getValidationErrorsForElement(string  $key) : mixed

Get valdation errors for element

Parameters

string $key

Returns

mixed

setHandler()

setHandler(\Fuman_Form_Handler  $handler)

Sets handler

Parameters

\Fuman_Form_Handler $handler

hasHandler()

hasHandler() : boolean

Returns

boolean

getTranslationLanguage()

getTranslationLanguage() : string

Returns

string

hasTranslationLanguage()

hasTranslationLanguage() : boolean

Returns

boolean

setTranslationLanguage()

setTranslationLanguage(string  $language)

Parameters

string $language

__construct()

__construct(\stdClass|null  $values = null, string|null  $translationPrefix = null, null|string  $key = null)

Constructor

Parameters

\stdClass|null $values
string|null $translationPrefix
null|string $key

hasElement()

hasElement(string  $key) : boolean

Has element

Parameters

string $key

Returns

boolean

removeElement()

removeElement(string  $key, boolean  $removeValidators = true, boolean  $removeValue = true, boolean  $removeDefaultValue = true) : void

Remove element

Parameters

string $key
boolean $removeValidators
boolean $removeValue
boolean $removeDefaultValue

removeElements()

removeElements() : 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.

getValues()

getValues() : \stdClass

Get values

Returns

\stdClass

resetValues()

resetValues() : void

Reset values

setValues()

setValues(\stdClass  $values = null)

Set values

Parameters

\stdClass $values

getValidators()

getValidators() : array<mixed,\Fuman_Validate_Abstract>

Get validator

Returns

array<mixed,\Fuman_Validate_Abstract>

addValidator()

addValidator(string  $key, \Fuman_Validate_Abstract  $validator)

Add validator

Parameters

string $key
\Fuman_Validate_Abstract $validator

addValidationError()

addValidationError(string  $key, string  $errorMessage)

Add validator error

Parameters

string $key
string $errorMessage

getValidationErrors()

getValidationErrors() : \stdClass

Gets validaton errors

Returns

\stdClass

hasElementValidators()

hasElementValidators(string  $key) : boolean

Has element validators

Parameters

string $key

Returns

boolean

getValidatorsForElement()

getValidatorsForElement(string  $key) : array<mixed,\Fuman_Validate_Abstract>

Get validators for element

Parameters

string $key

Returns

array<mixed,\Fuman_Validate_Abstract>

resetValidators()

resetValidators() : void

Reset validators

resetValidationErrors()

resetValidationErrors() : void

Reset validation errors

resetElements()

resetElements() : void

Removes all elements

getFormPrefix()

getFormPrefix() : string

Gets form prefix

Returns

string

setFormPrefix()

setFormPrefix(string  $formPrefix) : void

Sets form prefix

Parameters

string $formPrefix

setTranslationPrefix()

setTranslationPrefix(string  $translationPrefix)

Set translation prefix

Parameters

string $translationPrefix

getTranslationPrefix()

getTranslationPrefix() : string

Gets translation prefix

Returns

string

getTranslationPrefixAddOn()

getTranslationPrefixAddOn() : string

Get translation prefix add on

Returns

string

setTranslationPrefixAddOn()

setTranslationPrefixAddOn(string  $addOn) : void

Set translation prefix add on

Parameters

string $addOn

setTranslationKeyStrings()

setTranslationKeyStrings(string  $prefix, string  $addOn) : void

Set translation key strings

Parameters

string $prefix
string $addOn

getElementName()

getElementName(string  $key) : string

Get element name

Parameters

string $key

Returns

string

addElement()

addElement(string  $key, \Fuman_Response_Data  $element, boolean  $isRenderElement = true, null  $defaultValue = null) : \Fuman_Response_Data|\Fuman_InputType_Element

Add element

Parameters

string $key
\Fuman_Response_Data $element
boolean $isRenderElement
null $defaultValue

Returns

\Fuman_Response_Data|\Fuman_InputType_Element

create()

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

Create

Parameters

string $key
string $label
\Fuman_Form_Abstract $formElement
array $validators
boolean $renderElement
string|null $defaultValue

Returns

\Fuman_InputType_Element

createElement()

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

Create element

Parameters

string|null $translationPrefix

(if null, the internal translation prefix and addon will be used)
string $key
string $elementClassName
array|null $validators
boolean $renderElement
string|null $defaultValue

Returns

\Fuman_InputType_Element

getLabel()

getLabel(string  $translationPrefix, string  $key) : string

Get label for key

Parameters

string $translationPrefix
string $key

Returns

string

initValues()

initValues() : void

Init values

getAffectedRecord()

getAffectedRecord() : \Fuman_Db_Record

Get affected record

Returns

\Fuman_Db_Record

setAffectedRecord()

setAffectedRecord(\Fuman_Db_Record  $record)

Set affected record

Parameters

\Fuman_Db_Record $record