Fuman
\

\app_more_component_form

Created by JetBrains PhpStorm.

Usage: Example 1: $form = new app_more_component_form('contact'); $form->addCoreField('firstname'); $form->addCoreField('lastname'); $form->addEmailField('email'); $form->addCoreField('message', 'textarea'); $form->autoProcess();

Summary

Methods
Properties
Constants
__construct()
setAttribute()
setAttributes()
setDataAttribute()
hasAttribute()
hasDataAttribute()
getAttribute()
getAttributeValue()
getDataAttribute()
removeAttribute()
removeDataAttribute()
createAttribute()
prepareAttribute()
setFrontend()
isFrontend()
addCssFile()
addCssFiles()
getCssFiles()
hasCssFiles()
addJsFile()
addJsFiles()
setJsFiles()
getJsFiles()
hasJsFiles()
addJsClass()
addJsClasses()
hasJSClasses()
getJsClasses()
setJsClasses()
addJsProperty()
getJsProperties()
hasJsProperties()
addLockId()
hasLockIds()
getLockIds()
getTemplatePath()
hasTemplatePath()
setTemplatePath()
getData()
setData()
hasData()
getValue()
hasValue()
setValue()
__set()
__get()
__isset()
toObject()
getField()
setUseCaptcha()
getUseCaptcha()
getCaptchaFieldName()
hasField()
getFieldElement()
addField()
addCoreField()
addEmailField()
getName()
setName()
getTranslationPrefix()
setTranslationPrefix()
getAnchorName()
setAnchorName()
getSuccessKey()
setSuccessKey()
setShowForm()
getShowForm()
setValidateRecord()
getValidateRecord()
setSubmitClassName()
setSubmitValue()
getSubmit()
getSubmitValue()
getConfigHandler()
getFormModel()
getMailer()
setSendMailFlag()
getSendMailFlag()
getRecord()
setSaveRecordFlag()
getSaveRecordFlag()
setReceiverSource()
getReceiverSource()
setSubjectTemplate()
getSubjectTemplate()
setMailHtmlTemplatePath()
getMailHtmlTemplate()
setMailPlainTemplate()
getMailPlainTemplate()
setFormElementTemplatePath()
addDependency()
process()
isValidRequest()
cleanRecord()
autoProcess()
saveFormData()
sendMail()
saveRecord()
reRoute()
$form
DATA_PREFIX
JAVASCIPT_LOAD_TYPE_DEFAULT
JAVASCIPT_LOAD_TYPE_EXTERNAL
JAVASCIPT_LOAD_TYPE_EXTERNAL_ASYNC
STEP_FORM
STEP_ERROR
STEP_SUCCESS
STEP_FINISH
STEP_FAIL
RECEIVER_TRANSLATION
RECEIVER_CONFIG
RECEIVER_AUTO
_getTemplatePath()
_compareCssFiles()
_compareJsFiles()
_prepareMailData()
_isBot()
_setAutoProcessData()
$_data
$_templatePath
$_jsFiles
$_jsProperties
$_cssFiles
$_jsClasses
$_lockIds
$_isFrontend
$_successKey
$_formModel
$_request
$_mailer
$_record
$_name
$_translationPrefix
$_sendEmail
$_saveRecord
$_tableUniqueName
$_subjectTemplate
$_anchorName
$_requiredElementClassName
$_mailHtmlTemplate
$_mailPlainTemplate
$_receiverSource
$_dependencies
$_validateRecord
$_useCaptcha
$_captchaFieldKey
$_captchaFieldNames
$_captchaKeyName
$_captchaValue
$_submitClassName
N/A
No private methods found
No private properties found
N/A

Constants

DATA_PREFIX

DATA_PREFIX

JAVASCIPT_LOAD_TYPE_DEFAULT

JAVASCIPT_LOAD_TYPE_DEFAULT

JAVASCIPT_LOAD_TYPE_EXTERNAL

JAVASCIPT_LOAD_TYPE_EXTERNAL

JAVASCIPT_LOAD_TYPE_EXTERNAL_ASYNC

JAVASCIPT_LOAD_TYPE_EXTERNAL_ASYNC

STEP_FORM

STEP_FORM

STEP_ERROR

STEP_ERROR

STEP_SUCCESS

STEP_SUCCESS

STEP_FINISH

STEP_FINISH

STEP_FAIL

STEP_FAIL

RECEIVER_TRANSLATION

RECEIVER_TRANSLATION

RECEIVER_CONFIG

RECEIVER_CONFIG

RECEIVER_AUTO

RECEIVER_AUTO

Properties

$form

$form : \stdClass

Type

\stdClass

$_data

$_data : \stdClass

Data for template

Type

\stdClass

$_templatePath

$_templatePath : string

Path to the template file (*.phtml, .

..)

Type

string

$_jsFiles

$_jsFiles : array

List of required JS files

Type

array

$_jsProperties

$_jsProperties : array

List of JS properties

Type

array

$_cssFiles

$_cssFiles : array

List of required CSS files

Type

array

$_jsClasses

$_jsClasses : array

List of required JS classes

Type

array

$_lockIds

$_lockIds : array

List of lock ids

Type

array

$_isFrontend

$_isFrontend : boolean

Is this response used for frontend

Type

boolean

$_successKey

$_successKey : string

Type

string

$_name

$_name : string

Type

string

$_translationPrefix

$_translationPrefix : string

Type

string

$_sendEmail

$_sendEmail : boolean

Type

boolean

$_saveRecord

$_saveRecord : boolean

Type

boolean

$_tableUniqueName

$_tableUniqueName : string

Type

string

$_subjectTemplate

$_subjectTemplate :

Type

$_anchorName

$_anchorName : string

Type

string

$_requiredElementClassName

$_requiredElementClassName : string

Type

string

$_mailHtmlTemplate

$_mailHtmlTemplate : string

Type

string

$_mailPlainTemplate

$_mailPlainTemplate : string

Type

string

$_receiverSource

$_receiverSource : integer

Type

integer

$_dependencies

$_dependencies : array

Type

array

$_validateRecord

$_validateRecord : boolean

Type

boolean

$_useCaptcha

$_useCaptcha : boolean

Type

boolean

$_captchaFieldKey

$_captchaFieldKey : integer

Type

integer

$_captchaFieldNames

$_captchaFieldNames : array

Type

array

$_captchaKeyName

$_captchaKeyName : string

Type

string

$_captchaValue

$_captchaValue : string

Type

string

$_submitClassName

$_submitClassName : string

Type

string

Methods

__construct()

__construct(string  $name, string  $translationPrefix = 'custom_app_more_component_form', boolean  $sendEmail = true, boolean  $saveRecord = false, null  $tableUniqueName = null) : \Fuman_Response_Data

Constructor

Parameters

string $name
string $translationPrefix
boolean $sendEmail
boolean $saveRecord
null $tableUniqueName

Returns

\Fuman_Response_Data

setAttribute()

setAttribute(string  $key, string  $value, boolean  $appendValue = true, string  $appendSpacer = ' ') : void

Sets an attribute. If $appendValue is true, the value is going to be appended with the $appendSpacer argument.

Parameters

string $key
string $value
boolean $appendValue
string $appendSpacer

setAttributes()

setAttributes(array  $attributes, boolean  $appendValue = true, string  $appendSpacer = ' ')

Sets an array of attributes. If $appendValue is true, the value is going to be appended with the $appendSpacer argument.

Parameters

array $attributes
boolean $appendValue
string $appendSpacer

setDataAttribute()

setDataAttribute(string  $key, string  $value) : void

Sets a data attribute. Data attributes will always be overwritten.

Parameters

string $key
string $value

hasAttribute()

hasAttribute(string  $key) : boolean

Returns true if attribute is set.

Parameters

string $key

Returns

boolean

hasDataAttribute()

hasDataAttribute(string  $key) : boolean

Returns true if data attribute is set.

Parameters

string $key

Returns

boolean

getAttribute()

getAttribute(string  $key) : string|object

Returns attribute.

Parameters

string $key

Returns

string|object

getAttributeValue()

getAttributeValue(  $key) : string|null

Returns attribute value

Parameters

$key

Returns

string|null

getDataAttribute()

getDataAttribute(string  $key) : string

Returns data attribute.

Parameters

string $key

Returns

string

removeAttribute()

removeAttribute(string  $key) : void

Removes an attribute.

Parameters

string $key

removeDataAttribute()

removeDataAttribute(string  $key) : void

Removes a data attribute.

Parameters

string $key

createAttribute()

createAttribute(string  $key, string  $value) : \stdClass

Returns an attribute object.

Parameters

string $key
string $value

Returns

\stdClass

prepareAttribute()

prepareAttribute(string  $value) : string

Prepares an attribute (strips double quotes)

Parameters

string $value

Returns

string

setFrontend()

setFrontend(boolean  $flag)

Sets frontend flag for object If already set, method call will be ignored

Parameters

boolean $flag

isFrontend()

isFrontend() : boolean

Is object for a frontend request

Returns

boolean

addCssFile()

addCssFile(string  $path, string  $media = 'all', string|null  $packageName = null) : \Fuman_Response_Data

Add a CSS file

Parameters

string $path
string $media
string|null $packageName

Used for pack.php

Returns

\Fuman_Response_Data

addCssFiles()

addCssFiles(array  $cssFiles) : void

Adds an array of cssFiles the files will be internally added to the root response data object

Parameters

array $cssFiles

getCssFiles()

getCssFiles() : array

Returns all CSS files

Returns

array

hasCssFiles()

hasCssFiles() : boolean

Returns true when more than 0 css files are set

Returns

boolean

addJsFile()

addJsFile(string  $path, integer  $javaScriptLoadType, string|null  $packageName = null) : \Fuman_Response_Data

Add a Js file

Parameters

string $path
integer $javaScriptLoadType
string|null $packageName

Used for pack.php

Returns

\Fuman_Response_Data

addJsFiles()

addJsFiles(array  $jsFiles, boolean  $toTop = false) : void

Adds an array of jsFiles the files will be internally added to the root response data object

Parameters

array $jsFiles
boolean $toTop

setJsFiles()

setJsFiles(array  $jsFiles)

Set js files

Parameters

array $jsFiles

getJsFiles()

getJsFiles() : array

Returns all js files

Returns

array

hasJsFiles()

hasJsFiles() : boolean

Does the object contains js files

Returns

boolean

addJsClass()

addJsClass(string  $jsClassName, null|\stdClass  $options = null) : void

Adds an array of jsFiles the files will be internally added to the root response data object

Parameters

string $jsClassName
null|\stdClass $options

addJsClasses()

addJsClasses(array  $jsClasses) : void

Adds js classes

Parameters

array $jsClasses

hasJSClasses()

hasJSClasses() : boolean

Has javascript class

Returns

boolean

getJsClasses()

getJsClasses() : array

Get javascript classes

Returns

array

setJsClasses()

setJsClasses(array  $jsClasses)

Set javascript classes

Parameters

array $jsClasses

addJsProperty()

addJsProperty(string  $key, \stdClass|string  $value) : void

Adds JS properties the properties will be internally added to the root response data object

Parameters

string $key
\stdClass|string $value

getJsProperties()

getJsProperties() : array

Returns all js properties

Returns

array

hasJsProperties()

hasJsProperties() : boolean

Does the object contains js properties

Returns

boolean

addLockId()

addLockId(integer  $lockId) : void

Add lock id

Parameters

integer $lockId

hasLockIds()

hasLockIds() : boolean

Has lock ids

Returns

boolean

getLockIds()

getLockIds() : \array[int]

Get lock ids

Returns

\array[int]

getTemplatePath()

getTemplatePath() : string

Gets the script path

Returns

string

hasTemplatePath()

hasTemplatePath() : boolean

Has script path

Returns

boolean

setTemplatePath()

setTemplatePath(string  $templatePath) : \Fuman_Response_Data

Sets script path

Parameters

string $templatePath

Returns

\Fuman_Response_Data

getData()

getData() : null|\stdClass

Gets data object

Returns

null|\stdClass

setData()

setData(\stdClass  $data) : void

Sets data object

Parameters

\stdClass $data

hasData()

hasData() : boolean

Has data object

Returns

boolean

getValue()

getValue(string  $key) : object|string

Gets value

Parameters

string $key

Returns

object|string

hasValue()

hasValue(string  $key) : boolean

Has value

Parameters

string $key

Returns

boolean

setValue()

setValue(string  $key, mixed|object  $value) : void

Sets value

Parameters

string $key
mixed|object $value

__set()

__set(string  $key, object  $value) : void

Sets value on data

Parameters

string $key
object $value

__get()

__get(string  $key) : null

Gets value from data

Parameters

string $key

Returns

null

__isset()

__isset(string  $key) : boolean

Is set key on data

Parameters

string $key

Returns

boolean

toObject()

toObject() : \stdClass

Creates stdClass/object ot data object

Returns

\stdClass

setUseCaptcha()

setUseCaptcha(boolean  $useCaptcha)

Sets use captcha

Parameters

boolean $useCaptcha

getUseCaptcha()

getUseCaptcha() : boolean

Gets use captcha

Returns

boolean

getCaptchaFieldName()

getCaptchaFieldName() : string

Gets captcha field name

Returns

string

hasField()

hasField(string  $name) : boolean

Has field

Parameters

string $name

Returns

boolean

getFieldElement()

getFieldElement(string  $name) : mixed

Gets field element

Parameters

string $name

Returns

mixed

addField()

addField(string  $name, string  $className = 'app_core_form_textfield', boolean  $required = true, array  $validators = array(), boolean  $renderElement = true) : \Fuman_InputType_Element

Adds field

Parameters

string $name
string $className
boolean $required
array $validators
boolean $renderElement

Returns

\Fuman_InputType_Element

addCoreField()

addCoreField(string  $name, string  $formName = null, boolean  $required = true, array  $validators = array(), boolean  $renderElement = true) : \Fuman_InputType_Element

Adds core field

Parameters

string $name
string $formName
boolean $required
array $validators
boolean $renderElement

Returns

\Fuman_InputType_Element

addEmailField()

addEmailField(string  $name, boolean  $required = true) : \Fuman_InputType_Element

Adds email field

Parameters

string $name
boolean $required

Returns

\Fuman_InputType_Element

getName()

getName() : string

Gets name

Returns

string

setName()

setName(string  $name)

Sets name

Parameters

string $name

getTranslationPrefix()

getTranslationPrefix() : string

Gets translation prefix

Returns

string

setTranslationPrefix()

setTranslationPrefix(string  $translationPrefix)

Sets translation prefix

Parameters

string $translationPrefix

getAnchorName()

getAnchorName() : string

Gets anchor name

Returns

string

setAnchorName()

setAnchorName(string  $anchorName)

Sets anchor name

Parameters

string $anchorName

getSuccessKey()

getSuccessKey() : string

Gets success key

Returns

string

setSuccessKey()

setSuccessKey(string  $successKey)

Sets success key

Parameters

string $successKey

setShowForm()

setShowForm(boolean  $showForm)

Sets show form

Parameters

boolean $showForm

getShowForm()

getShowForm() : boolean

Gets show form

Returns

boolean

setValidateRecord()

setValidateRecord(boolean  $validateRecord)

Sets validate record

Parameters

boolean $validateRecord

getValidateRecord()

getValidateRecord() : boolean

Gets validate record

Returns

boolean

setSubmitClassName()

setSubmitClassName(string  $className)

Set submit class name

Parameters

string $className

setSubmitValue()

setSubmitValue(string  $submit)

Sets submit value

Parameters

string $submit

getSubmitValue()

getSubmitValue() : string

Gets submit value

Returns

string

getConfigHandler()

getConfigHandler()

Gets config handler

setSendMailFlag()

setSendMailFlag(boolean  $sendEmail)

Sets send mail flag

Parameters

boolean $sendEmail

getSendMailFlag()

getSendMailFlag() : boolean

Gets send mail flag

Returns

boolean

getRecord()

getRecord() : \Fuman_Db_Record

Gets record

Returns

\Fuman_Db_Record

setSaveRecordFlag()

setSaveRecordFlag(boolean  $saveRecord)

Sets save record flag

Parameters

boolean $saveRecord

getSaveRecordFlag()

getSaveRecordFlag() : boolean

Gets save record flag

Returns

boolean

setReceiverSource()

setReceiverSource(integer  $receiverSource)

Sets retriever source

Parameters

integer $receiverSource

getReceiverSource()

getReceiverSource() : integer

Gets retriever source

Returns

integer

setSubjectTemplate()

setSubjectTemplate(string  $template)

Sets subject template

Parameters

string $template

getSubjectTemplate()

getSubjectTemplate() : string

Gets subject template

Returns

string

setMailHtmlTemplatePath()

setMailHtmlTemplatePath(string  $path)

Set mail Html template path

Parameters

string $path

getMailHtmlTemplate()

getMailHtmlTemplate() : string

Gets mail Html template

Returns

string

setMailPlainTemplate()

setMailPlainTemplate(string  $path)

Sets mail plain template

Parameters

string $path

getMailPlainTemplate()

getMailPlainTemplate() : string

Gets mail plain template

Returns

string

setFormElementTemplatePath()

setFormElementTemplatePath(string  $path)

Sets form element template path

Parameters

string $path

Throws

\Fuman_Exception

addDependency()

addDependency(string  $sourceField, string  $sourceValue, string|array<mixed,string>  $targetFields, boolean  $hide = true)

Adds dependency

Parameters

string $sourceField
string $sourceValue
string|array<mixed,string> $targetFields
boolean $hide

process()

process() : integer

Process

Returns

integer —

status

isValidRequest()

isValidRequest() : boolean

Returns

boolean

cleanRecord()

cleanRecord() : void

Clean record

autoProcess()

autoProcess(boolean  $reroute = true, boolean  $initTranslations = true) : boolean

Auto process

Parameters

boolean $reroute
boolean $initTranslations

Returns

boolean

saveFormData()

saveFormData() : boolean

Save form data

Returns

boolean

sendMail()

sendMail() : boolean

Send mail

Throws

\Exception

Returns

boolean

saveRecord()

saveRecord() : boolean

Save record

Returns

boolean

reRoute()

reRoute()

Reroute

_getTemplatePath()

_getTemplatePath() : string

Returns path to phtml.

Returns

string

_compareCssFiles()

_compareCssFiles(\stdClass  $a, \stdClass  $b) : integer

Compares css files

Parameters

\stdClass $a
\stdClass $b

Returns

integer

_compareJsFiles()

_compareJsFiles(\stdClass  $a, \stdClass  $b) : integer

Compares JS files

Parameters

\stdClass $a
\stdClass $b

Returns

integer

_prepareMailData()

_prepareMailData() : \stdClass

Prepare mail data

Returns

\stdClass

_isBot()

_isBot() : boolean

Is bot

Returns

boolean

_setAutoProcessData()

_setAutoProcessData(integer  $step)

Sets auto process data

Parameters

integer $step