IESA
Programa de Feedback Gerencial y Liderazgo
 Todo Estructuras de Datos Archivos Funciones Variables
Métodos públicos | Atributos protegidos
Referencia de la Clase Usuario

Métodos públicos

 __construct ($id=NULL)
 getUsuario ($data)
 getUsuarioPorId ($id)
 getUsuarioPorCorreoElectronico ($correo)
 getUsuarioPorCredenciales ($correo, $clave)
 guardar ()
 getNombreCompleto ()
 eliminar ()
 getId ()
 setNombres ($val)
 getNombres ()
 setApellidos ($val)
 getApellidos ()
 setCorreoElectronico ($val)
 getCorreoElectronico ()
 setRolId ($val)
 getRolId ()
 getRol ()
 permite ($val)
 setClave ($val)
 cambiarClave ($val)
 setStatus ($val)
 getStatus ()
 getTipoDeCuenta ()

Atributos protegidos

 $usu_id
 $usu_nombres
 $usu_apellidos
 $usu_correo_electronico
 $usu_clave
 $usu_rol_id
 $usu_status = 1

Descripción detallada

Clase Usuario.

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

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

Documentación del constructor y destructor

__construct ( $  id = NULL)

Método __construct. Crea una instancia de la clase. El parámetro opcional $id, es usado para los cargar datos de la cuenta de usuario cuyo id coincida con dicho paràmetro.

Parámetros:
$idNumero ID de la cuenta a cargar. Tipo Entero, valor por defecto NULL

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

Documentación de las funciones miembro

cambiarClave ( $  val)

Método cambiarClave. Cambia la clave asociada al registro cargado en la estructura. Este método actualiza el registro de la base de datos de forma inmediata.

Devuelve:
Booleano

Definición en la línea 427 del archivo Usuario.class.php.

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 281 del archivo Usuario.class.php.

getApellidos ( )

Método getApellidos. Retorna el valor del campo Apellidos de la cuenta de usuario.

Devuelve:
Cadena de caracteres.

Definición en la línea 336 del archivo Usuario.class.php.

getCorreoElectronico ( )

Método getCorreoElectronico. Retorna el valor del campo Correo Electrónico de la cuenta de usuario.

Devuelve:
Cadena de caracteres.

Definición en la línea 354 del archivo Usuario.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 300 del archivo Usuario.class.php.

getNombreCompleto ( ) 
  Metodo getNombreCompleto(  )
          Retorna el nombre completo del usuario de la siguiente forma:
          Nombres, Apellidos
Devuelve:
Cadena de caracteres

Definición en la línea 266 del archivo Usuario.class.php.

getNombres ( )

Método getNombres. Retorna el valor del campo Nombres de la cuenta de usuario.

Devuelve:
Cadena de caracteres.

Definición en la línea 318 del archivo Usuario.class.php.

getRol ( )

Método getRol. Retorna un objeto de tipo stdClass con attributos del rol asociado a la cuenta de usuario. Los atributos del objeto retornado son Nombre, Descripción, Estatus y permisos

Devuelve:
objeto stdClass.

Definición en la línea 383 del archivo Usuario.class.php.

getRolId ( )

Método getCorreoElectronico. Retorna el id del rol asociado a la cuenta de usuario.

Devuelve:
Entero.

Definición en la línea 372 del archivo Usuario.class.php.

getStatus ( )

Método getStatus. Retorna el valor del campo Clave de la cuenta de usuario.

Devuelve:
Entero.

Definición en la línea 463 del archivo Usuario.class.php.

getTipoDeCuenta ( )

Método getTipoDeCuenta. Retorna el valor del campo Clave de la cuenta de usuario.

Devuelve:
Entero.

Definición en la línea 472 del archivo Usuario.class.php.

getUsuario ( $  data)

Método getUsuario. 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:
$dataDefine el criterio de busqueda a utilizar. Tipo Arreglo.
Devuelve:
Tipo Booleano

Definición en la línea 78 del archivo Usuario.class.php.

getUsuarioPorCorreoElectronico ( $  correo)

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

Parámetros:
$correoLa direccion de correo del registro a obtener. Tipo Entero.
Devuelve:
Tipo Booleano

Definición en la línea 164 del archivo Usuario.class.php.

getUsuarioPorCredenciales ( $  correo,
$  clave 
)

Método getUsuarioPorCredenciales( ) Carga los datos a la estructura interna desde la base de datos, filtrando los registros por los campos usu_correo_electronico y usu_clave

Parámetros:
$correoDireccion de correo electrónico asociada a la cuenta. Tipo Cadena de caracteres.
$claveClave secreta asociada a la cuenta. Tipo Cadena de caracteres.
Devuelve:
Booleano

Definición en la línea 188 del archivo Usuario.class.php.

getUsuarioPorId ( $  id)

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

Parámetros:
$idEl id del registro a obtener. Tipo Entero.
Devuelve:
Tipo Booleano

Definición en la línea 143 del archivo Usuario.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 209 del archivo Usuario.class.php.

permite ( $  val) 
   Método permite.
           Verifica si el rol asociado a la cuenta de usuarios, 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 Rol.
        //Para validar si el rol asociado permite la edición de usuarios:
        $usuario->permite( Rol::EDITAR_USUARIOS )

        //Para validar si el rol asociado permite la eliminación de usuarios:
        $usuario->permite( Rol::ELIMINAR_USUARIOS )
Parámetros:
$valCualquiera de las constantes de permisos definidas en la clase Rol. Tipo entero
Devuelve:
Booleano

Definición en la línea 407 del archivo Usuario.class.php.

setApellidos ( $  val)

Método setNombres. Asigna un valor al campo Apellidos de la cuenta de usuario.

Parámetros:
$valValor a asignar. Tipo Cadena de caracteres.

Definición en la línea 327 del archivo Usuario.class.php.

setClave ( $  val)

Método setClave. Asigna el valor del campo Clave de la cuenta de usuario.

Parámetros:
$valValor a asignar. Tipo Cadena de caracteres.

Definición en la línea 416 del archivo Usuario.class.php.

setCorreoElectronico ( $  val)

Método setCorreoElectronico. Asigna un valor al campo Correo Electrónico de la cuenta de usuario.

Parámetros:
$valValor a asignar. Tipo Cadena de caracteres.

Definición en la línea 345 del archivo Usuario.class.php.

setNombres ( $  val)

Método setNombres. Asigna un valor al campo Nombres de la cuenta de usuario.

Parámetros:
$valValor a asignar. Tipo Cadena de caracteres.

Definición en la línea 309 del archivo Usuario.class.php.

setRolId ( $  val)

Método setRolId. Especifica el id del rol a asociar con la cuenta de usuario.

Parámetros:
$valValor a asignar. Tipo entero.

Definición en la línea 363 del archivo Usuario.class.php.

setStatus ( $  val)

Método setStatus. Asigna el valor del campo Clave de la cuenta de usuario.

Parámetros:
$valValor a asignar. Tipo entero.

Definición en la línea 454 del archivo Usuario.class.php.

Documentación de los campos

$usu_apellidos [protected]

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

$usu_clave [protected]

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

$usu_correo_electronico [protected]

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

$usu_id [protected]

Definición en la línea 14 del archivo Usuario.class.php.

$usu_nombres [protected]

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

$usu_rol_id [protected]

Definición en la línea 19 del archivo Usuario.class.php.

$usu_status = 1 [protected]

Definición en la línea 20 del archivo Usuario.class.php.

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