FacturaScripts

ApiPlugins extends ApiController
in package

Controlador de la API para gestionar los plugins de la aplicació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

Methods

__construct()  : mixed
Inicializa el controlador asociado a una ruta.
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
getUriParam()  : string
runResource()  : void
applyFilter()  : array<string|int, mixed>
applySort()  : array<string|int, mixed>
compare()  : bool
disablePlugin()  : void
enablePlugin()  : void
formatPluginData()  : array<string|int, mixed>
getLogMessages()  : string
getPlugin()  : void
handlePluginAction()  : void
listPlugins()  : void
validatePluginAccess()  : object|null

Constants

INCIDENT_EXPIRATION_TIME

public mixed INCIDENT_EXPIRATION_TIME = 600

Properties

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.

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.

getUriParam()

protected getUriParam(string $num) : string
Parameters
$num : string
Return values
string

applyFilter()

private applyFilter(array<string|int, mixed> $plugins, array<string|int, mixed> $filter) : array<string|int, mixed>
Parameters
$plugins : array<string|int, mixed>
$filter : array<string|int, mixed>
Return values
array<string|int, mixed>

applySort()

private applySort(array<string|int, mixed> $plugins, array<string|int, mixed> $sort) : array<string|int, mixed>
Parameters
$plugins : array<string|int, mixed>
$sort : array<string|int, mixed>
Return values
array<string|int, mixed>

compare()

private compare(mixed $a, mixed $b, string $operator) : bool
Parameters
$a : mixed
$b : mixed
$operator : string
Return values
bool

disablePlugin()

private disablePlugin(string $pluginName) : void
Parameters
$pluginName : string

enablePlugin()

private enablePlugin(string $pluginName) : void
Parameters
$pluginName : string

formatPluginData()

private formatPluginData(object $plugin) : array<string|int, mixed>
Parameters
$plugin : object
Return values
array<string|int, mixed>

getLogMessages()

private getLogMessages([string $default = '' ]) : string
Parameters
$default : string = ''
Return values
string

getPlugin()

private getPlugin(string $pluginName) : void
Parameters
$pluginName : string

handlePluginAction()

private handlePluginAction(string $pluginName, string $action) : void
Parameters
$pluginName : string
$action : string

validatePluginAccess()

private validatePluginAccess(string $pluginName) : object|null
Parameters
$pluginName : string
Return values
object|null
On this page

Search results