Inheritance diagram for form_range_abstract:

Public Member Functions
	toHtml ()

	setValue ($value, $refill=false, $key=null)

	getValue ($key=null, $mode='raw')

	renew ()

	getName ()

	getValue ()

&	getRawValue ()

	setValue ($value, $refill=false)

	getDescription ()

	getValid ()

	isValid ()

	getValidRule ($name)

	setDisabled ($disabled)

	getErrors ()

	addCustomError ($error)

	addRule ($type, $prm=null)

	delRule ($type)

	isHidden ()

	getType ()

	to ($type)

	toXul ()

	__toString ()

	__get ($name)

	__set ($name, $val)

	getAttr ($name)

	setAttr ($name, $value)

	getCfg ()

Protected Member Functions
	afterInit ()

	makeId ($name)

	initValid ()

	beforeInit ()

Protected Attributes
	$valid

	$customErrors = array()

	$cfg

Detailed Description

Form numeric element

Definition at line 10 of file form/range/abstract.class.php.

Member Function Documentation

◆ __get()

__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()

__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()

__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()

addCustomError ( $error )

inherited

Add a custom error

Parameters

string $error The error text

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

◆ addRule()

addRule	(	$type,
		$prm = `null`
	)

inherited

Add a rule from the valdiation

Parameters

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

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

◆ afterInit()

afterInit ( )

protectedinherited

Set up the valid object

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

◆ beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

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

◆ delRule()

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()

getAttr ( $name )

inherited

Get an attribute

Parameters

string $name Attribute name

Returns: mixed|null The attribute or null if not set

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

◆ getCfg()

getCfg ( )

inherited

Get the configuration object

Returns: config

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

◆ getDescription()

getDescription ( )

inherited

Get the description field

Returns: string

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

◆ getErrors()

getErrors ( )

inherited

Get all the errors for the last validation

Returns: array

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

◆ getName()

getName ( )

inherited

Get the field name

Returns: string

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

◆ getRawValue()

& getRawValue ( )

inherited

Get the raw value

Returns: mixed

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

◆ getType()

getType ( )

inherited

Get the form element type

Returns: string

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

◆ getValid()

getValid ( )

inherited

Get the valid object

Returns: valid

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

◆ getValidRule()

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() [1/2]

getValue	(	$key = `null`,
		$mode = `'raw'`
	)

Get the actual value

Parameters

null \| string	$key	Null to get both values or string to get only one
string	$mode	How get the value in case of retriving only one value

Returns: mixed

Definition at line 57 of file form/range/abstract.class.php.

◆ getValue() [2/2]

getValue ( )

inherited

Get the actual value

Returns: mixed

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

◆ initValid()

initValid ( )

protectedinherited

Set the validation rules

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

◆ isHidden()

isHidden ( )

inherited

Check if the element is hidden

Returns: bool

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

◆ isValid()

isValid ( )

inherited

Check if the element is valid by using the valid object

Returns: bool True if valid

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

◆ makeId()

makeId ( $name )

protectedinherited

Make a valid id from a name

Parameters

string $name

Returns: string

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

◆ renew()

renew ( )

inherited

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

◆ setAttr()

setAttr	(	$name,
		$value
	)

inherited

Set an attribute

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

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

◆ setDisabled()

setDisabled ( $disabled )

inherited

Set the disabled state

Parameters

boolean $disabled

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

◆ setValue() [1/2]

setValue	(	$value,
		$refill = `false`,
		$key = `null`
	)

Set the form element value

Parameters

mixed	$value	The value
boolean	$refill	Indicate if the value is a refill one
null \| string	$key	Null if set both values or string to set only one value

Definition at line 36 of file form/range/abstract.class.php.

◆ setValue() [2/2]

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

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

◆ to()

to ( $type )

inherited

Transform the element to a string to be shown

Parameters

string $type The output type

Returns: string

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

◆ toHtml()

toHtml ( )

Definition at line 12 of file form/range/abstract.class.php.

◆ toXul()

toXul ( )

inherited

Transform the element in a XUL string

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

Field Documentation

◆ $cfg

$cfg

protectedinherited

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

◆ $customErrors

$customErrors = array()

protectedinherited

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

◆ $valid

$valid

protectedinherited

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

The documentation for this class was generated from the following file:

form/range/abstract.class.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __get()

◆ __set()

◆ __toString()

◆ addCustomError()

◆ addRule()

◆ afterInit()

◆ beforeInit()

◆ delRule()

◆ getAttr()

◆ getCfg()

◆ getDescription()

◆ getErrors()

◆ getName()

◆ getRawValue()

◆ getType()

◆ getValid()

◆ getValidRule()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ initValid()

◆ isHidden()

◆ isValid()

◆ makeId()

◆ renew()

◆ setAttr()

◆ setDisabled()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ to()

◆ toHtml()

◆ toXul()

Field Documentation

◆ $cfg

◆ $customErrors

◆ $valid