jFormsDataContainer
in package
this object is a container for form data
Tags
Table of Contents
- $data : array<string|int, mixed>
- contains data provided by the user in each controls
- $errors : array<string|int, mixed>
- list of errors detected in data
- $formId : string
- the instance id of the form
- $formSelector : jSelectorForm
- the selector of the xml file of the form
- $originalData : array<string|int, mixed>
- contains data provided by the user in each controls
- $privateData : array<string|int, mixed>
- internal use. Used by controls object to store some private data. (captcha for example)
- $refcount : mixed
- reference counter for the 'anonymous' form id (jForms::DEFAULT_ID)
- $token : mixed
- token for security against CSRF
- $updatetime : int
- the last date when the form has been used
- $deactivated : mixed
- $readOnly : mixed
- __construct() : mixed
- clear() : mixed
- deactivate() : mixed
- isActivated() : bool
- check if a control is activated
- isReadOnly() : bool
- check if a control is activated
- setReadOnly() : mixed
- unsetData() : mixed
Properties
$data
contains data provided by the user in each controls
public
array<string|int, mixed>
$data
= array()
$errors
list of errors detected in data
public
array<string|int, mixed>
$errors
= array()
$formId
the instance id of the form
public
string
$formId
$formSelector
the selector of the xml file of the form
public
jSelectorForm
$formSelector
$originalData
contains data provided by the user in each controls
public
array<string|int, mixed>
$originalData
= array()
Tags
$privateData
internal use. Used by controls object to store some private data. (captcha for example)
public
array<string|int, mixed>
$privateData
= array()
$refcount
reference counter for the 'anonymous' form id (jForms::DEFAULT_ID)
public
mixed
$refcount
= 0
$token
token for security against CSRF
public
mixed
$token
= ''
$updatetime
the last date when the form has been used
public
int
$updatetime
= 0
$deactivated
protected
mixed
$deactivated
= array()
$readOnly
protected
mixed
$readOnly
= array()
Methods
__construct()
public
__construct(jSelectorForm $formSelector, string $formId) : mixed
Parameters
- $formSelector : jSelectorForm
- $formId : string
Return values
mixed —clear()
public
clear() : mixed
Return values
mixed —deactivate()
public
deactivate(mixed $name[, mixed $deactivation = true ]) : mixed
Parameters
- $name : mixed
- $deactivation : mixed = true
Return values
mixed —isActivated()
check if a control is activated
public
isActivated(string $name) : bool
Parameters
- $name : string
-
the control name
Return values
bool —true if it is activated
isReadOnly()
check if a control is activated
public
isReadOnly(string $name) : bool
Parameters
- $name : string
-
the control name
Return values
bool —true if it is activated
setReadOnly()
public
setReadOnly(mixed $name[, mixed $readonly = true ]) : mixed
Parameters
- $name : mixed
- $readonly : mixed = true
Return values
mixed —unsetData()
public
unsetData(mixed $name) : mixed
Parameters
- $name : mixed