API Documentation
Table of Contents
Classes
- Conexion
- Clase SingleStone que maneja la conexion a BBDD
- ControladorCampania
- Controlador de campania Tablas afectadas : Campania.
- ControladorLayouts
- Controlador de layouts de usuarioWeb.
- ControladorMedidas
- Controlador de medidas / secundarios.
- ControladorPermisos
- ControladorTipo
- Controlador de tipos.
- ControladorUsers
- Controlador de usuarios Tablas afectadas : users y usuario web.
- campaniaDao
- layoutUserDao
- Clase DAO para encapsular operaciones CRUD Maneja las peticiones a la tabla layoutUser
- layoutUserItemDao
- Clase DAO para encapsular operaciones CRUD Maneja las peticiones a la tabla layoutUser_Item, en ahora llamado Items
- layoutUserItemSerieDao
- Clase DAO para encapsular operaciones CRUD Maneja las peticiones a la tabla layoutUser_Item_Serie, en ahora Series
- paginasDao
- SecundarioDao
- SubtipoPrimarioDao
- SubtiposecundarioDao
- TipoDao
- TipoSecundarioDao
- UsersDao
- Clase DAO para encapsular operaciones CRUD Maneja las peticiones a la tabla users
- usuarioWebDao
- Clase DAO para encapsular operaciones CRUD Maneja las peticiones a la tabla usuario_web
- Campania
- Entidad que representa a la tabla campania del sistema
- layoutUser
- Entidad que representa a la tabla layoutUser del sistema
- layoutUserItem
- Entidad que representa a la tabla layoutUser_item del sistema
- layoutUserItemSerie
- Entidad que representa a la tabla layoutUser_item_serie del sistema
- paginas
- Secundario
- Entidad que representa a la tabla Secundario del sistema
- Subtipoprimario
- Entidad que representa a la tabla subtipoPrimario del sistema
- Subtiposecundario
- Entidad que representa a la tabla tipoSecundario del sistema
- Tipo
- Entidad que representa a la tabla tipo del sistema
- TipoSecundario
- Entidad que representa a la tabla tipoSecundario del sistema
- Users
- Entidad que representa a la tabla users del sistema Gestiona los datos del perfil y el control y verificación de contraseñas
- usuarioWeb
- Entidad que representa a la tabla usuarioWeb del sistema Gestiona los datos del perfil y el control y verificación de contraseñas
- ApiTestCase
- Clase base abstracta para todos los tests de la API.
- AuthTest
- Test unitarios de todas las funciones relacionadas con auth
- GeneralTest
- Test unitarios de todas las funciones relacionadas con la estructura general de la API
- Layoutstest
- Test unitarios de todas las funciones relacionadas con layouts
- MedidasTest
- Test unitarios de todas las funciones relacionadas con medidas
- Userstest
- Test unitarios de todas las funciones relacionadas con usuarios_web
- SuperToken
- Clase para gestionar la creacion de tokens
- Utils_format
- Funciones de utilidad compartidas entre controladores.
Functions
- jsonResponse() : never
- Emite una respuesta JSON y termina la ejecución.
- requireAuth() : void
- Valida sesión activa + binding IP/UA.
- requireAuth() : void
- tieneAcceso() : bool
- Funcion que sirve para verificar si un usuario tiene acceso a una pagina concreta
Functions
jsonResponse()
Emite una respuesta JSON y termina la ejecución.
jsonResponse(mixed $data[, int $status = 200 ]) : never
Parameters
- $data : mixed
-
Datos a serializar.
- $status : int = 200
-
Código HTTP de respuesta.
Return values
neverrequireAuth()
Valida sesión activa + binding IP/UA.
requireAuth() : void
Aborta con 401 si no supera la comprobación.
requireAuth()
requireAuth(string $rutaActual[, int $_level = 0 ]) : void
Parameters
- $rutaActual : string
- $_level : int = 0
Tags
tieneAcceso()
Funcion que sirve para verificar si un usuario tiene acceso a una pagina concreta
tieneAcceso(string $ruta) : bool
Parameters
- $ruta : string
-
: ruta de la pagina ( se considera frontend/ como raiz )
Return values
bool —si tiene o no acceso