Documentación de Proyecto Sincro

ControladorLayouts

Controlador de layouts de usuarioWeb.

Tablas afectadas : layoutUser, layoutUser_item, layoutUser_item_serie Gestiona creación, consulta y eliminación de layouts y sus items.

Tags
see
layoutUserDao
see
layoutUserItemDao
see
utils_format
used-by

ProyectoSincro\backend\api

requires

PHP 8.0 Uso de tipado estricto y funciones de strings.

Table of Contents

Methods

createNewLayout()  : int
Crea un layout con todos sus items en una sola operación.
deactivateLayout()  : void
Borrado logico: pone activo = 0, el registro permanece en la BD.
deleteLayout()  : void
Borrado fisico: elimina el layout y todos sus items de la BD.
getByUserId()  : array<string|int, mixed>
Devuelve la lista de layouts activos del usuarioWeb (solo cabecera: id + nombre).
updateLayout()  : void
Sobreescribe un layout existente: actualiza cabecera y reemplaza todos sus items.

Methods

createNewLayout()

Crea un layout con todos sus items en una sola operación.

public static createNewLayout(string $nombre, int $userId, array<string|int, mixed> $items) : int
Parameters
$nombre : string

: Nombre del layout

$userId : int

: Id del usuario asociado

$items : array<string|int, mixed>

: Items que poblará el layout

Tags
throws
Exception
Return values
int —

ID del layout creado

deactivateLayout()

Borrado logico: pone activo = 0, el registro permanece en la BD.

public static deactivateLayout(int $layoutId, int $userId) : void

No pensado para implementacion

Parameters
$layoutId : int
$userId : int
Tags
throws
Exception

deleteLayout()

Borrado fisico: elimina el layout y todos sus items de la BD.

public static deleteLayout(int $layoutId, int $userId) : void
Parameters
$layoutId : int

: id del layout

$userId : int

: id del usuario

Tags
throws
Exception

getByUserId()

Devuelve la lista de layouts activos del usuarioWeb (solo cabecera: id + nombre).

public static getByUserId(int $userId) : array<string|int, mixed>

Usada para poblar el combobox del frontend.

Parameters
$userId : int

: id del usuario

Tags
throws
Exception
Return values
array<string|int, mixed> —

lista de layouts. Formato : [{id, nombre}, ...]

updateLayout()

Sobreescribe un layout existente: actualiza cabecera y reemplaza todos sus items.

public static updateLayout(int $layoutId, int $userId, string $nombre, array<string|int, mixed> $items) : void

Operación atómica via transacción.

Parameters
$layoutId : int

: id del layout a modificar

$userId : int

: id del usuario

$nombre : string

: nuevo nombre del layout

$items : array<string|int, mixed>

: nuevos items

Tags
throws
Exception

        
On this page

Search results