Documentación de Proyecto Sincro

ControladorUsers

Controlador de usuarios Tablas afectadas : users y usuario web.

Responsable de autenticación

Tags
see
usersDao
see
usuarioWebDao
see
users
see
usuarioWeb
used-by

ProyectoSincro\Backend\api

requires

PHP 8.0 Uso de tipado estricto y funciones de strings.

Table of Contents

Methods

createUser()  : int
Valida y crea un nuevo usuarioWeb.
createUsuarioWeb()  : array<string|int, mixed>
Crea un nuevo usuario web
deleteLogicUsuario()  : array<string|int, mixed>
Borrado LOGICO de un usuario
deleteUser()  : array<string|int, mixed>
Borrado FISICO de un usuario
getAllUsuariosWeb()  : array<string|int, mixed>
Obtiene todos los usuarios del sistema SOLO PARA ADMINISTRADOR O SUPERUSUARIO
login()  : array{user_id: int, nombre: string, centro: int}
Valida credenciales, rehashea si es necesario y devuelve los datos de sesión.
loginUsuarioWeb()  : array{user_id: int, nombre: string, centro: int}
Valida credenciales, rehashea si es necesario y devuelve los datos de sesión.
updateUser()  : array<string|int, mixed>
Actualiza datos generales de un usuario, no su contraseña
updateUserPassword()  : array<string|int, mixed>
Actualiza la contraseña de un usuario, verificandola antes

Methods

createUser()

Valida y crea un nuevo usuarioWeb.

public static createUser(string $nombre, string $apellido1, string $apellido2, string $dni, string $email, string $password, string $passwordConfirm, int $centro, string $cif) : int

dejada por si se requiere una interfaz más comoda

Toda la validación de negocio vive aquí; la API no toca reglas de negocio.

Parameters
$nombre : string
$apellido1 : string
$apellido2 : string
$dni : string
$email : string
$password : string
$passwordConfirm : string
$centro : int
$cif : string
Tags
throws
Exception
Return values
int —

ID del nuevo usuarioWeb

createUsuarioWeb()

Crea un nuevo usuario web

public static createUsuarioWeb(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

: datos del nuevo usuario

Tags
note

verifica los permisos de quien haya realizado la peticion, SOLO ADMINS

Return values
array<string|int, mixed> —

JSON response

deleteLogicUsuario()

Borrado LOGICO de un usuario

public static deleteLogicUsuario(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

solo tiene le id de borrado

Return values
array<string|int, mixed> —

JSON response

deleteUser()

Borrado FISICO de un usuario

public static deleteUser(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

solo tiene el id de borrado

Return values
array<string|int, mixed> —

JSON response

getAllUsuariosWeb()

Obtiene todos los usuarios del sistema SOLO PARA ADMINISTRADOR O SUPERUSUARIO

public static getAllUsuariosWeb() : array<string|int, mixed>
Tags
throws
Exception
Return values
array<string|int, mixed>

login()

Valida credenciales, rehashea si es necesario y devuelve los datos de sesión.

public static login(string $login, string $password) : array{user_id: int, nombre: string, centro: int}

Siempre lanza Exception con mensaje genérico para no revelar información interna.

Parameters
$login : string
$password : string
Tags
throws
Exception
Return values
array{user_id: int, nombre: string, centro: int}

loginUsuarioWeb()

Valida credenciales, rehashea si es necesario y devuelve los datos de sesión.

public static loginUsuarioWeb(string $login, string $password) : array{user_id: int, nombre: string, centro: int}
Parameters
$login : string

: clave de login, usuario en este caso

$password : string

: contraseña sin hashear del usuario

Tags
throws
Exception
Return values
array{user_id: int, nombre: string, centro: int} —

: datos del usuario

updateUser()

Actualiza datos generales de un usuario, no su contraseña

public static updateUser(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

datos del usuario provenientes del front

Return values
array<string|int, mixed> —

JSON de respuesta

updateUserPassword()

Actualiza la contraseña de un usuario, verificandola antes

public static updateUserPassword(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

: id, password_nueva, password_actual

Return values
array<string|int, mixed> —

JSON respuesta


        
On this page

Search results