ApiRoot
extends ApiController
in package
Controlador raíz de la API, que expone los recursos disponibles y su documentación.
Table of Contents
Constants
- API_VERSION : mixed = 3
- INCIDENT_EXPIRATION_TIME : mixed = 600
- IP_LIST : mixed = 'api-ip-list'
- MAX_INCIDENT_COUNT : mixed = 5
Properties
- $apiKey : ApiKey
- $request : Request
- $response : Response
- $url : string
- $custom_resources : array<string|int, mixed>
Methods
- __construct() : mixed
- Inicializa el controlador asociado a una ruta.
- addCustomResource() : void
- getCustomResources() : array<string|int, mixed>
- getPageData() : array<string|int, mixed>
- Devuelve los metadatos de la página, como el nombre, título, icono y ubicación en el menú.
- run() : void
- Ejecuta el ciclo principal del controlador para procesar la petición actual.
- db() : DataBase
- exposeResources() : void
- getResourcesMap() : array<string|int, mixed>
- getUriParam() : string
- runResource() : void
Constants
API_VERSION
public
mixed
API_VERSION
= 3
INCIDENT_EXPIRATION_TIME
public
mixed
INCIDENT_EXPIRATION_TIME
= 600
IP_LIST
public
mixed
IP_LIST
= 'api-ip-list'
MAX_INCIDENT_COUNT
public
mixed
MAX_INCIDENT_COUNT
= 5
Properties
$apiKey
protected
ApiKey
$apiKey
$request
protected
Request
$request
$response
protected
Response
$response
$url
protected
string
$url
$custom_resources
private
static array<string|int, mixed>
$custom_resources
= ['crearAlbaranCliente', 'crearAlbaranProveedor', 'crearFacturaCliente', 'crearFacturaProveedor', 'crearFacturaRectificativaCliente', 'crearPedidoCliente', 'crearPedidoProveedor', 'crearPresupuestoCliente', 'crearPresupuestoProveedor', 'editarAlbaranCliente', 'editarAlbaranProveedor', 'editarFacturaCliente', 'editarFacturaProveedor', 'editarPedidoCliente', 'editarPedidoProveedor', 'editarPresupuestoCliente', 'editarPresupuestoProveedor', 'exportarAlbaranCliente', 'exportarAlbaranProveedor', 'exportarFacturaCliente', 'exportarFacturaProveedor', 'exportarPedidoCliente', 'exportarPedidoProveedor', 'exportarPresupuestoCliente', 'exportarPresupuestoProveedor', 'pagarFacturaCliente', 'pagarFacturaProveedor', 'plugins', 'uploadFiles']
Methods
__construct()
Inicializa el controlador asociado a una ruta.
public
__construct(string $className[, string $url = '' ]) : mixed
Parameters
- $className : string
-
Nombre de la clase final del controlador.
- $url : string = ''
-
Ruta solicitada por el usuario.
addCustomResource()
public
static addCustomResource(string $name) : void
Parameters
- $name : string
getCustomResources()
public
static getCustomResources() : array<string|int, mixed>
Return values
array<string|int, mixed>getPageData()
Devuelve los metadatos de la página, como el nombre, título, icono y ubicación en el menú.
public
getPageData() : array<string|int, mixed>
Este método se consulta durante la construcción y no debe depender de que el usuario esté autenticado.
Return values
array<string|int, mixed>run()
Ejecuta el ciclo principal del controlador para procesar la petición actual.
public
run() : void
El kernel invoca este método una vez después de construir el controlador.
db()
protected
db() : DataBase
Return values
DataBaseexposeResources()
protected
exposeResources(array<string|int, mixed> &$map) : void
Parameters
- $map : array<string|int, mixed>
getResourcesMap()
protected
getResourcesMap() : array<string|int, mixed>
Return values
array<string|int, mixed>getUriParam()
protected
getUriParam(string $num) : string
Parameters
- $num : string
Return values
stringrunResource()
protected
runResource() : void