Referencia de la Clase Rol

Métodos públicos
	__construct ($id=NULL)
	getRol ($data)
	getRolPorId ($id)
	getRolPorNombre ($nombre)
	guardar ()
	eliminar ()
	permite ($val)
	getId ()
	setNombre ($val)
	getNombre ()
	setDescripcion ($val)
	getDescripcion ()
	setPermisos ($val)
	getPermisos ()
	setStatus ($val)
	getStatus ()
Campos de datos
const	LISTAR_USUARIOS = 1
const	CREAR_USUARIOS = 2
const	EDITAR_USUARIOS = 4
const	ELIMINAR_USUARIOS = 8
const	LISTAR_ROLES = 16
const	CREAR_ROLES = 32
const	EDITAR_ROLES = 64
const	ELIMINAR_ROLES = 128
const	LISTAR_EVALUACIONES = 256
const	CREAR_EVALUACIONES = 512
const	EDITAR_EVALUACIONES = 1024
const	ELIMINAR_EVALUACIONES = 2048
const	LISTAR_INVENTARIOS = 4096
const	CREAR_INVENTARIOS = 8192
const	EDITAR_INVENTARIOS = 16384
const	ELIMINAR_INVENTARIOS = 32768
const	ESTATUS_ACTIVO = 1
const	ESTATUS_INACTIVO = 2
Atributos protegidos
	$rol_id
	$rol_nombre
	$rol_descripcion
	$rol_status = 1
	$rol_permisos = 0

---

Descripción detallada

Clase Rol

Esta clase define un estructura capaz de acceder y actualizar los datos relativos a un rol, donde cada atributo de la clase tendrá su equivalente en los campos de la tabla roles.

Definición en la línea 12 del archivo Rol.class.php.

---

Documentación del constructor y destructor

__construct

(

$

id = NULL

)

Método __construct. Crea una instancia de la clase. El parametro opcional $id, es usado para los cargar datos del rol cuyo id coincida con dicho parametro.

Parámetros:

$id	Numero ID del Rol a cargar. Tipo Entero, valor por defecto NULL

Definición en la línea 57 del archivo Rol.class.php.

---

Documentación de las funciones miembro

eliminar

(

)

  Método eliminar.
          Elimina de la base de datos, aquel registro vinculado a la estructura por el id.

Devuelve:

Numero de registros afectados, que deberían ser 0 ó 1. Tipo entero.

Definición en la línea 223 del archivo Rol.class.php.

getDescripcion

(

)

Método getDescripcion. Retorna la descripción del rol cargado en la estructura.

Devuelve:

Cadena de caracteres.

Definición en la línea 304 del archivo Rol.class.php.

getId

(

)

Método getId. Retorna el Id del registro cargado en la estructura.

Devuelve:

Entero o Nulo en caso de no tener un Id válido

Definición en la línea 268 del archivo Rol.class.php.

getNombre

(

)

Método getNombre. Retorna el Nombre del rol cargado en la estructura.

Devuelve:

Cadena de caracteres.

Definición en la línea 286 del archivo Rol.class.php.

getPermisos

(

)

Método getPermisos. Retorna la la permisología asignada al rol.

Devuelve:

Entero.

Definición en la línea 341 del archivo Rol.class.php.

getRol

(

$

data

)

Método getRol. Carga los datos en la estructura, a partir de un registro en la base de datos que cumpla con el criterio de busqueda

Parámetros:

$data

Define el criterio de busqueda a utilizar. Tipo Arreglo.

Devuelve:

Tipo Booleano

Definición en la línea 95 del archivo Rol.class.php.

getRolPorId

(

$

id

)

Método getRolPorId( ). Carga los datos en la estructura, a partir de un registro en la base de datos que cuyo id coincida con el parámetro de entrada.

Parámetros:

$id	El id del registro a obtener. Tipo Entero.

Devuelve:

Tipo Booleano

Definición en la línea 138 del archivo Rol.class.php.

getRolPorNombre

(

$

nombre

)

Método getRolPorNombre( ). Carga los datos en la estructura, a partir de un registro en la base de datos que cuyo campo rol_nombre coincida con el parámetro de entrada.

Parámetros:

$nombre

El nombre del registro a obtener. Tipo Entero.

Devuelve:

Tipo Booleano

Definición en la línea 159 del archivo Rol.class.php.

getStatus

(

)

Método getStatus. Retorna el estatus actual del rol.

Devuelve:

Entero.

Definición en la línea 361 del archivo Rol.class.php.

guardar

(

)

  Método guardar.
          Guarda los datos contenidos en la estructura.
          Se determinará de forma automática si es un "INSERT" o un "UPDATE"
          de la tabla.

Devuelve:

Numero de registros afectados, que deberían ser 0 ó 1. Tipo entero.

Definición en la línea 177 del archivo Rol.class.php.

permite

(

$

val

)

   Método permite.
           Verifica si el rol vinculado, puede realizar la operación especificada
           por el parámetro $val y donde dicho parámetro, puede ser cualquiera 
           de las constantes definidas en la clase.

        //Para validar si el rol permite la edición de usuarios:
        $rol->permite( Rol::EDITAR_USUARIOS )

        //Para validar si el rol permite la eliminación de usuarios:
        $rol->permite( Rol::ELIMINAR_USUARIOS )

Parámetros:

$val	Cualquiera de las constantes de permisos definidas en la clase. Tipo entero

Devuelve:

Booleano

Definición en la línea 257 del archivo Rol.class.php.

setDescripcion

(

$

val

)

Método setDescripcion. Asigna una descripción al rol.

Parámetros:

$val	Descripción a asignar. Tipo Cadena de caracteres.

Definición en la línea 295 del archivo Rol.class.php.

setNombre

(

$

val

)

Método setNombre. Asigna el nombre del rol.

Parámetros:

$val	Nombre a asignar. Tipo Cadena de caracteres.

Definición en la línea 277 del archivo Rol.class.php.

setPermisos

(

$

val

)

   Método setPermisos.
           Asigna la perisología al rol.
           Como parámetro de entrada, se acepta cualquier combinación de las constantes de permisos
           definidas en la clase. Cada vez que se ejecute este método, se substituirán los permisos
           ya asignados al rol por los definidos en el parámetro $val

        //Asigna permiso de eliminar cuentas de usuarios
        $rol->setPermisos( Rol::ELIMINAR_USUARIOS );

        //Asigna permiso de editar cuentas de usuarios. Se perderá el permiso asignado previamente
        $rol->setPermisos( Rol::EDITAR_USUARIOS );

        //Asigna permiso de eliminar cuentas de usuarios y editar roles sin perder los permisos 
        //ya asignados
        $rol->setPermisos(
                $rol->getPermisos(  ) | Rol::ELIMINAR_USUARIOS | Rol::EDITAR_ROLES
        );

Parámetros:

$val	Perisología a asignar. Tipo entero.

Definición en la línea 332 del archivo Rol.class.php.

setStatus

(

$

val

)

Método setStatus. Cambia el estatus del rol. Como parámetro de entrada, se acepta cualquiera de las constantes de estatus definidas en la clase.

Parámetros:

$val	Estatus a asignar. Tipo entero.

Definición en la línea 352 del archivo Rol.class.php.

---

Documentación de los campos

$rol_descripcion [protected]

Definición en la línea 43 del archivo Rol.class.php.

$rol_id [protected]

Definición en la línea 41 del archivo Rol.class.php.

$rol_nombre [protected]

Definición en la línea 42 del archivo Rol.class.php.

$rol_permisos = 0 [protected]

Definición en la línea 45 del archivo Rol.class.php.

$rol_status = 1 [protected]

Definición en la línea 44 del archivo Rol.class.php.

const CREAR_EVALUACIONES = 512

Definición en la línea 28 del archivo Rol.class.php.

const CREAR_INVENTARIOS = 8192

Definición en la línea 33 del archivo Rol.class.php.

const CREAR_ROLES = 32

Definición en la línea 22 del archivo Rol.class.php.

const CREAR_USUARIOS = 2

Definición en la línea 16 del archivo Rol.class.php.

const EDITAR_EVALUACIONES = 1024

Definición en la línea 29 del archivo Rol.class.php.

const EDITAR_INVENTARIOS = 16384

Definición en la línea 34 del archivo Rol.class.php.

const EDITAR_ROLES = 64

Definición en la línea 23 del archivo Rol.class.php.

const EDITAR_USUARIOS = 4

Definición en la línea 17 del archivo Rol.class.php.

const ELIMINAR_EVALUACIONES = 2048

Definición en la línea 30 del archivo Rol.class.php.

const ELIMINAR_INVENTARIOS = 32768

Definición en la línea 35 del archivo Rol.class.php.

const ELIMINAR_ROLES = 128

Definición en la línea 24 del archivo Rol.class.php.

const ELIMINAR_USUARIOS = 8

Definición en la línea 18 del archivo Rol.class.php.

const ESTATUS_ACTIVO = 1

Definición en la línea 38 del archivo Rol.class.php.

const ESTATUS_INACTIVO = 2

Definición en la línea 39 del archivo Rol.class.php.

const LISTAR_EVALUACIONES = 256

Definición en la línea 27 del archivo Rol.class.php.

const LISTAR_INVENTARIOS = 4096

Definición en la línea 32 del archivo Rol.class.php.

const LISTAR_ROLES = 16

Definición en la línea 21 del archivo Rol.class.php.

const LISTAR_USUARIOS = 1

Definición en la línea 15 del archivo Rol.class.php.

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• core/Rol.class.php