Usuario
in package
Modelo de acceso a datos Usuario
Table of Contents
Properties
- $DB : mixed
Methods
- __construct() : mixed
- Constructor
- __destruct() : mixed
- Cierra conexión al base de datos antes de destruir el objeto.
- addUsuario() : int
- Añade el usuario con los datos indicados
- checkLoginUsuario() : bool
- Devuelve true si el usuario y contraseña están dados de alta
- deleteUsuarioID() : mixed
- borra el usuario con ID pasado
- existenUsuarios() : bool
- Devuelve true si la tabla de usuarios no está vacia (existe al menos un usuario)
- existeUsuarioId() : true
- Devuelve true si existe el usuario con ID indicado
- existeUsuarioLogin() : true
- Devuelve true si existe el usuario con login indicado.
- generarCodigoRecuperaPass() : string
- Genera un código de recuperación de contraseña, para envío por mail.
- getReposUserId() : array<string|int, mixed>
- Devuelve una lista de identificadores de repositorios donde el usuario tiene acceso
- getUsuarioCodigoRecuperaPass() : UsuarioData|null
- Recupera el usuario correspondiente al código de recuperación enviado o null en caso contrario
- getUsuarioId() : UsuarioData
- Devuelve información del usuario con ID indicado
- getUsuarioLogin() : UsuarioData
- Devuelve el usuario con Login indicado
- getUsuarios() : mixed
- Devuelve un array con todos los usuarios
- getUsuariosRepo() : mixed
- Devuelve un array con todos los usuarios con identificadores en un repositorio específico
- getUsuariosRol() : mixed
- Devuelve un array con todos los usuarios con un rol específico
- updatePassUsuarioID() : mixed
- Actualiza contraseña de usuario con ID indicado
- updateUsuarioID() : bool
- Actualiza datos de usuario con ID indicado
- getDB() : DB
- Devuelve el objeto de acceso a la base de datos.
Properties
$DB
private
mixed
$DB
Methods
__construct()
Constructor
public
__construct([DB $DB = null ]) : mixed
Parameters
- $DB : DB = null
-
Objeto conexión a la base de datos para trabajar. si no se le pasa trata de recuperarlo del fichero de configuración.
__destruct()
Cierra conexión al base de datos antes de destruir el objeto.
public
__destruct() : mixed
addUsuario()
Añade el usuario con los datos indicados
public
addUsuario(UsuarioData $usuario) : int
Parameters
- $usuario : UsuarioData
-
Objeto con los datos del usuario
Return values
int —ID del usuario en la base de datos
checkLoginUsuario()
Devuelve true si el usuario y contraseña están dados de alta
public
final checkLoginUsuario(string $login, string $pass) : bool
Parameters
- $login : string
-
El login del usuario
- $pass : string
-
La contraseña del usuario (original, sin encriptar)
Return values
bool —true si el usuario existe (solo 1 usuario) y la contraseña es correcta
deleteUsuarioID()
borra el usuario con ID pasado
public
deleteUsuarioID(int $id) : mixed
Parameters
- $id : int
-
ID del usuario a borrar
existenUsuarios()
Devuelve true si la tabla de usuarios no está vacia (existe al menos un usuario)
public
existenUsuarios() : bool
Return values
bool —True si al menos existe un usuario en la base de datos.
existeUsuarioId()
Devuelve true si existe el usuario con ID indicado
public
existeUsuarioId(int $id) : true
Parameters
- $id : int
-
El id del usuario a buscar
Return values
true —si existe un usuario con id indicado
existeUsuarioLogin()
Devuelve true si existe el usuario con login indicado.
public
existeUsuarioLogin(string $login) : true
Parameters
- $login : string
-
login del usuario
Return values
true —si existe un usuario con login indicado
generarCodigoRecuperaPass()
Genera un código de recuperación de contraseña, para envío por mail.
public
generarCodigoRecuperaPass(int $id) : string
Elimina cualquier código generado anterior.
Parameters
- $id : int
-
ID del usuario a recuperar contraseña
Return values
string —Código generado.
getReposUserId()
Devuelve una lista de identificadores de repositorios donde el usuario tiene acceso
public
getReposUserId(int $idUsuario) : array<string|int, mixed>
Parameters
- $idUsuario : int
-
ID del usuario
Return values
array<string|int, mixed> —con los ID's de los repositorios donde el usuario tiene acceso.
getUsuarioCodigoRecuperaPass()
Recupera el usuario correspondiente al código de recuperación enviado o null en caso contrario
public
getUsuarioCodigoRecuperaPass(string $codigo) : UsuarioData|null
Parameters
- $codigo : string
-
código de recuperación de usuario.
Return values
UsuarioData|null —Datos del usuario recuperado o null
getUsuarioId()
Devuelve información del usuario con ID indicado
public
getUsuarioId(int $idUsuario) : UsuarioData
Parameters
- $idUsuario : int
Return values
UsuarioData —datos del usuario recuperado.
getUsuarioLogin()
Devuelve el usuario con Login indicado
public
getUsuarioLogin(string $login) : UsuarioData
Parameters
- $login : string
Return values
UsuarioData —datos del usuario recuperado.false si no encontrado
getUsuarios()
Devuelve un array con todos los usuarios
public
getUsuarios() : mixed
Return values
mixed —Array con los usuarios (UsuarioData). False en caso de no encontrar.
getUsuariosRepo()
Devuelve un array con todos los usuarios con identificadores en un repositorio específico
public
getUsuariosRepo(int $idRepositorio) : mixed
Parameters
- $idRepositorio : int
-
id del repositorio a buscar
Return values
mixed —con los usuarios posibles del repositorio.
getUsuariosRol()
Devuelve un array con todos los usuarios con un rol específico
public
getUsuariosRol(string $rol) : mixed
Parameters
- $rol : string
-
Rol a buscar (admin, repoadmin, user)
Return values
mixed —Array de usuarios que tienen el rol indicado.
updatePassUsuarioID()
Actualiza contraseña de usuario con ID indicado
public
updatePassUsuarioID(int $id, string $pass) : mixed
Parameters
- $id : int
-
ID del usuario a actualizar en la base de datos
- $pass : string
-
Contraseña nueva del usuario.
updateUsuarioID()
Actualiza datos de usuario con ID indicado
public
updateUsuarioID(UsuarioData $Usuario) : bool
Parameters
- $Usuario : UsuarioData
-
Objeto con datos de usuario.
Return values
bool —True si se actualiza correctamente.
getDB()
Devuelve el objeto de acceso a la base de datos.
private
getDB() : DB
Return values
DB —Objeto de acceso a la base de datos