Public Member Functions | Protected Member Functions | Protected Attributes

form_list Class Reference

Inheritance diagram for form_list:
form_mulValue form_abstract object

Public Member Functions

 getValue ($outside=true)
 getValue ()
 setValue ($value, $refill=false)
 to ($type)
 toHtml ()
 toXul ()
 isInValue ($val)
 renew ()
 getName ()
getRawValue ()
 getDescription ()
 getValid ()
 isValid ()
 getValidRule ($name)
 setDisabled ($disabled)
 getErrors ()
 addCustomError ($error)
 addRule ($type, $prm=null)
 delRule ($type)
 isHidden ()
 getType ()
 __toString ()
 __get ($name)
 __set ($name, $val)
 getAttr ($name)
 setAttr ($name, $value)
 getCfg ()

Protected Member Functions

 afterInit ()
 updateLine ($type, $val, $line)
 makeId ($name)
 initValid ()
 beforeInit ()

Protected Attributes

 $valid
 $customErrors = array()
 $cfg

Detailed Description

Form list element

Definition at line 10 of file list.class.php.


Member Function Documentation

__get ( name  )  [inherited]

Get a variable directly from the configuration, with a convenient way $config->name

Parameters:
string $name Value requested
Returns:
mixed The value requested, null if it doesn't exists

Definition at line 263 of file form/abstract.class.php.

__set ( name,
val 
) [inherited]

Set a variable directly from the configuration, with a convenient way $config->name = $value

Parameters:
string $name Value requested
mixed $value Value to set

Definition at line 273 of file form/abstract.class.php.

__toString (  )  [inherited]

Transform the element to a string to be shown, with the courant output

Returns:
string

Definition at line 253 of file form/abstract.class.php.

addCustomError ( error  )  [inherited]

Add a custom error

Parameters:
string $error The error text

Definition at line 185 of file form/abstract.class.php.

addRule ( type,
prm = null 
) [inherited]

Add a rule from the valdiation

Parameters:
string $type Validation type
array $prm Parameter for this rule

Reimplemented in form_captcha.

Definition at line 195 of file form/abstract.class.php.

afterInit (  )  [protected]

Initialize the list and group with a sql request if provided

Reimplemented from form_mulValue.

Definition at line 12 of file list.class.php.

beforeInit (  )  [protected, inherited]

Call just before the configuration initialisation

Reimplemented in form_file.

Definition at line 35 of file object.class.php.

delRule ( type  )  [inherited]

Delete a rule from the valdiation

Parameters:
string $type Validation type

Definition at line 204 of file form/abstract.class.php.

getAttr ( name  )  [inherited]

Get an attribute

Parameters:
string $name Attribute name
Returns:
mixed|null The attribute or null if not set

Reimplemented in response_proxy.

Definition at line 48 of file object.class.php.

getCfg (  )  [inherited]

Get the configuration object

Returns:
config

Definition at line 67 of file object.class.php.

getDescription (  )  [inherited]

Get the description field

Returns:
string

Definition at line 105 of file form/abstract.class.php.

getErrors (  )  [inherited]

Get all the errors for the last validation

Returns:
array

Reimplemented in form_captcha.

Definition at line 176 of file form/abstract.class.php.

getName (  )  [inherited]

Get the field name

Returns:
string

Definition at line 66 of file form/abstract.class.php.

& getRawValue (  )  [inherited]

Get the raw value

Returns:
mixed

Definition at line 84 of file form/abstract.class.php.

getType (  )  [inherited]

Get the form element type

Returns:
string

Definition at line 222 of file form/abstract.class.php.

getValid (  )  [inherited]

Get the valid object

Returns:
valid

Reimplemented in form_captcha.

Definition at line 132 of file form/abstract.class.php.

getValidRule ( name  )  [inherited]

Get a valide rule config

Parameters:
string $name Rule name
Returns:
null|mixed Null if not set or configuration if existing

Definition at line 151 of file form/abstract.class.php.

getValue (  )  [inherited]

Get the actual value

Returns:
mixed

Reimplemented in form_date, form_file, and form_richtext.

Definition at line 75 of file form/abstract.class.php.

getValue ( outside = true  )  [inherited]

Get the actual value

Parameters:
bool $outside Indicate if it's coming from outside (ie if it should be htmlDeOut)
Returns:
mixed

Definition at line 66 of file mulValue.class.php.

initValid (  )  [protected, inherited]

Set the validation rules

Definition at line 115 of file form/abstract.class.php.

isHidden (  )  [inherited]

Check if the element is hidden

Returns:
bool

Reimplemented in form_hidden.

Definition at line 213 of file form/abstract.class.php.

isInValue ( val  )  [inherited]

Check if a value is in the current value

Parameters:
mixed $val
Returns:
bool

Reimplemented in form_checkbox_fields.

Definition at line 180 of file mulValue.class.php.

isValid (  )  [inherited]

Check if the element is valid by using the valid object

Returns:
bool True if valid

Reimplemented in form_captcha.

Definition at line 141 of file form/abstract.class.php.

makeId ( name  )  [protected, inherited]

Make a valid id from a name

Parameters:
string $name
Returns:
string

Definition at line 55 of file form/abstract.class.php.

renew (  )  [inherited]

Definition at line 45 of file form/abstract.class.php.

setAttr ( name,
value 
) [inherited]

Set an attribute

Parameters:
string $name Attribute name
mixed $value Attribute value

Reimplemented in response_proxy.

Definition at line 58 of file object.class.php.

setDisabled ( disabled  )  [inherited]

Set the disabled state

Parameters:
boolean $disabled

Definition at line 163 of file form/abstract.class.php.

setValue ( value,
refill = false 
) [inherited]

Set the form element value

Parameters:
mixed $value The value
boolean $refill Indicate if the value is a refill one

Reimplemented from form_abstract.

Reimplemented in form_autocomplete, and form_checkbox_fields.

Definition at line 79 of file mulValue.class.php.

to ( type  )  [inherited]

Transform the element to a string to be shown

Parameters:
string $type The output type
Returns:
string

Reimplemented from form_abstract.

Reimplemented in form_autocomplete, and form_checkbox_fields.

Definition at line 87 of file mulValue.class.php.

toHtml (  )  [inherited]

Transform the element in a HTML string

Reimplemented from form_abstract.

Definition at line 166 of file mulValue.class.php.

toXul (  )  [inherited]

Transform the element in a XUL string

Reimplemented from form_abstract.

Definition at line 170 of file mulValue.class.php.

updateLine ( type,
val,
line 
) [protected, inherited]

Update a line before adding to the out

Parameters:
string $type Out type
mixed $val The line value
string $line The current line
Returns:
string The updated line

Reimplemented in form_checkbox_fields.

Definition at line 162 of file mulValue.class.php.


Field Documentation

$cfg [protected, inherited]

Definition at line 17 of file object.class.php.

$customErrors = array() [protected, inherited]

Definition at line 24 of file form/abstract.class.php.

$valid [protected, inherited]

Definition at line 17 of file form/abstract.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Enumerations
Generated on Tue May 8 2012 16:02:25 for nyroFwk by doxygen 1.7.1