RMFormGroups Class Reference

Inheritance diagram for RMFormGroups:

Public Member Functions
	__construct ($caption, $name, $multi=0, $type=0, $cols=2, $select=array())
	getCols ()
	getMulti ()
	getSelect ()
	getShowDesc ()
	getShowType ()
	render ()
	setCols ($value)
	setMulti ($value)
	setSelect ($value)
	setShowType ($value)
	showDesc ($value)
Public Member Functions inherited from RMFormElement
	addClass ($class)
	getCaption ()
	getClass ()
	getDescription ()
	getExtra ()
	getForm ()
	getName ()
	id ()
	render ()
	setCaption ($caption)
	setClass ($class)
	setDescription ($desc)
	setExtra ($extra)
	setForm ($name)
	setId ($id)
	setName ($name)

Private Attributes
	$_cols = 2
	$_multi = 0
	$_select = array()
	$_showdesc = 0
	$_showtype = 0

Additional Inherited Members
Static Public Attributes inherited from RMFormElement
static	$elementsIds = array()

Detailed Description

Clase para la creación de campos para el manejo de grupos de usuarios XOOPS

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

Constructor & Destructor Documentation

RMFormGroups::__construct	(		$caption,
			$name,
			$multi = 0,
			$type = 0,
			$cols = 2,
			$select = array()
	)

Constructor de la clase

Parameters

string	$caption	Texto de la etiqueta
string	$name	Nombre del campo

Definition at line 32 of file groups.class.php.

References $cols, $type, RMFormElement\getName(), RMFormElement\setCaption(), and RMFormElement\setName().

Here is the call graph for this function:

Member Function Documentation

RMFormGroups::getCols

(

)

Devuelve el número de columnas del menú.

Returns

int

Definition at line 133 of file groups.class.php.

References $_cols.

RMFormGroups::getMulti

(

)

Devuelve el valor multi del campo groups.

Returns

int

Definition at line 63 of file groups.class.php.

References $_multi.

RMFormGroups::getSelect

(

)

Devuelve el array con los identificadores de los grupos seleccionado por defecto.

Returns

array

Definition at line 86 of file groups.class.php.

References $_select.

RMFormGroups::getShowDesc

(

)

Devuelve si esta activa o no la opción para mostrar la descrpición de los grupos

Returns

int

Definition at line 117 of file groups.class.php.

References $_showdesc.

RMFormGroups::getShowType

(

)

Devuelve el identificador de la forma en que se muestran los elementos

Returns

int

Definition at line 101 of file groups.class.php.

References $_showtype.

RMFormGroups::render

(

)

Genera el código HTML para mostrar la lista o menú de grupos

Returns

string

Definition at line 140 of file groups.class.php.

References $db, $result, $rtn, and RMFormElement\getName().

Here is the call graph for this function:

RMFormGroups::setCols

(

$value

)

Establece el número de columnas para el menu. Cuando los grupos se mostrarán en forma de menú esta opción permite especificar el número de columnas en las que se ordenarán.

Parameters

int

$value

Número de columnas

Definition at line 126 of file groups.class.php.

RMFormGroups::setMulti

(

$value

)

Establece el comportamiento de seleccion del campo groups. Si $_multi = 0 entonces olo se puede seleccionar un grupo a la vez. En caso contrario el campo permite la selección de múltiples grupos

Parameters

int

$value

1 o 2

Definition at line 53 of file groups.class.php.

References RMFormElement\getName(), and RMFormElement\setName().

Here is the call graph for this function:

RMFormGroups::setSelect

(

$value

)

Indica los elementos seleccionados por defecto. Este valor debe ser pasado como un array conteniendo los ideneitificadores de los grupos (ej. array(0,1,2,3)) o bien como una lista delimitada por comas conteniendo tambien los identificadores de grupos (ej, 1,2,3,4)

Parameters

array	$value	Identificadores de los grupos
string	$value	Lista delimitada por comas con identificadores de los grupos

Definition at line 74 of file groups.class.php.

RMFormGroups::setShowType

(

$value

)

Establece la forma en que se mostrarán los grupos. Esto puede ser en forma de lista o en forma de menu

Parameters

int

$value

0 ó 1

Definition at line 94 of file groups.class.php.

RMFormGroups::showDesc

(

$value

)

Establece si se muestra la descripción de cada grupo o no. Esta valor solo puede afectar cuando lso grupos se muestran en forma de menu.

Parameters

int

$value

0 ó 1

Definition at line 110 of file groups.class.php.

Member Data Documentation

RMFormGroups::$_cols = 2

private

Definition at line 25 of file groups.class.php.

Referenced by getCols().

RMFormGroups::$_multi = 0

private

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

Referenced by getMulti().

RMFormGroups::$_select = array()

private

Definition at line 18 of file groups.class.php.

Referenced by getSelect().

RMFormGroups::$_showdesc = 0

private

Definition at line 24 of file groups.class.php.

Referenced by getShowDesc().

RMFormGroups::$_showtype = 0

private

Posibles valores 0 = Select, 1 = Menu

Definition at line 23 of file groups.class.php.

Referenced by getShowType().

---

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

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/fields/groups.class.php