Docs For Class jFormsDataContainer

Description

this object is a container for form data

Located in /forms/jFormsDataContainer.class.php (line 16)

Variable Summary

array $data

mixed $deactivated

array $errors

string $formId

jSelectorForm $formSelector

array $originalData

array $privateData

mixed $readOnly

mixed $refcount

mixed $token

integer $updatetime

Method Summary

jFormsDataContainer __construct (jSelectorForm $formSelector, string $formId)

void clear ()

void deactivate ( $name, [ $deactivation = true])

boolean isActivated (string $name)

boolean isReadOnly (string $name)

void setReadOnly ( $name, [ $readonly = true])

void unsetData ( $name)

Variables

array $data = array() (line 21)

contains data provided by the user in each controls

access: public

mixed $deactivated = array() (line 78)

access: protected

array $errors = array() (line 52)

list of errors detected in data

access: public

string $formId (line 41)

the instance id of the form

access: public

jSelectorForm $formSelector (line 46)

the selector of the xml file of the form

access: public

array $originalData = array() (line 29)

contains data provided by the user in each controls

see: jFormsBase::getModifiedControls()
see: jFormsBase::initModifiedControlsList()
access: public

array $privateData = array() (line 35)

internal use. Used by controls object to store some private data. (captcha for example)

access: public

mixed $readOnly = array() (line 73)

access: protected

mixed $refcount = 0 (line 68)

reference counter for the 'anonymous' form id (jForms::DEFAULT_ID)

access: public

mixed $token = '' (line 63)

token for security against CSRF

access: public

integer $updatetime = 0 (line 58)

the last date when the form has been used

access: public

Methods

Constructor __construct (line 84)

jFormsDataContainer __construct (jSelectorForm $formSelector, string $formId)

jSelectorForm $formSelector
string $formId

clear (line 93)

void clear ()

deactivate (line 102)

access: public

void deactivate ( $name, [ $deactivation = true])

$name
$deactivation

isActivated (line 127)

check if a control is activated

return: true if it is activated
access: public

boolean isActivated (string $name)

string $name: the control name

isReadOnly (line 136)

check if a control is activated

return: true if it is activated
access: public

boolean isReadOnly (string $name)

string $name: the control name

setReadOnly (line 112)

access: public

void setReadOnly ( $name, [ $readonly = true])

$name
$readonly

unsetData (line 89)

void unsetData ( $name)

$name