axCheckboxGroupHelper Class Reference

Checkbox Group Helper Class. More...

Inheritance diagram for axCheckboxGroupHelper:

Public Member Functions
	__construct ($name, array $values=array())
	Constructor.
	addOption ($label, $value)
	Add an option (a checkbox) to the group.
	addOptions (array $values)
	Add multiple options at once.
	setValue ($value)
	getName ()
	Get group's name.
Static Public Member Functions
static	export ($name, array $values=array())
	Constructor static alias.
Protected Attributes
	$_name
	Inner input's name.
Static Protected Attributes
static	$_count = 1
	Current position.

---

Detailed Description

Checkbox Group Helper Class.

Author:

Delespierre

Copyright:

Copyright 2010-2011, Benjamin Delespierre (http://bdelespierre.fr)

License:

http://www.gnu.org/licenses/lgpl.html Lesser General Public Licence version 3

Definition at line 15 of file axCheckboxGroupHelper.class.php.

---

Constructor & Destructor Documentation

axCheckboxGroupHelper::__construct	(	$	name,
		array $	values = array()
	)

Constructor.

Parameters:

string	$name	Group name (HTML name attribute value)
array	$values	[optional] [default array()] Values list (one per checkbox), keys will be used as label

Definition at line 34 of file axCheckboxGroupHelper.class.php.

---

Member Function Documentation

axCheckboxGroupHelper::addOption	(	$	label,
		$	value
	)

Add an option (a checkbox) to the group.

Parameters:

string	$label
scalar	$value

Returns:

axCheckboxGroupHelper

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

axCheckboxGroupHelper::addOptions

(

array $

values

)

Add multiple options at once.

See also:

axCheckboxGroupHelper::addOption()

Parameters:

array

$values

Values list (one per checkbox), keys will be used as label

Returns:

axCheckboxGroupHelper

Definition at line 60 of file axCheckboxGroupHelper.class.php.

static axCheckboxGroupHelper::export	(	$	name,
		array $	values = array()
	)		[static]

Constructor static alias.

See also:

axCheckboxGroupHelper::__construct

Parameters:

string	$name
array	$values	[optional] [default array()]

Returns:

axCheckboxGroupHelper

Definition at line 95 of file axCheckboxGroupHelper.class.php.

axCheckboxGroupHelper::getName

(

)

Get group's name.

Returns:

string

Definition at line 83 of file axCheckboxGroupHelper.class.php.

axCheckboxGroupHelper::setValue

(

$

value

)

Set the node's value.

Parameters:

mixed

$value

Returns:

axHelper

Reimplemented from axBaseHelper.

Definition at line 69 of file axCheckboxGroupHelper.class.php.

---

Field Documentation

integer axCheckboxGroupHelper::$_count = 1 [static, protected]

Current position.

Definition at line 27 of file axCheckboxGroupHelper.class.php.

string axCheckboxGroupHelper::$_name [protected]

Inner input's name.

Definition at line 21 of file axCheckboxGroupHelper.class.php.

---

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

• H:/Workspace/php-axiom/www/php-axiom/libraries/axiom/axCheckboxGroupHelper.class.php