About
extends Controller
in package
Clase de la que deben heredar todos los controladores de FacturaScripts.
Table of Contents
Properties
- $data : array<string|int, mixed>
- $empresa : Empresa
- Empresa seleccionada.
- $multiRequestProtection : MultiRequestProtection
- $permissions : ControllerPermissions
- Permisos del usuario sobre este controlador.
- $request : Request
- Petición de la que podemos obtener datos.
- $title : string
- Título de la página.
- $uri : string
- URI dada, por defecto vacía.
- $user : User|false
- Usuario que ha iniciado sesión.
- $dataBase : DataBase
- Proporciona acceso directo a la base de datos.
- $response : Response
- Objeto de respuesta HTTP.
Methods
- __construct() : mixed
- Inicializa todos los objetos y propiedades.
- addExtension() : mixed
- getPageData() : array<string|int, mixed>
- Devuelve los datos básicos de esta página (nombre, título, icono, menú, etc.).
- getTemplate() : string|false
- Devuelve la plantilla a usar para este controlador.
- pipe() : mixed
- pipeFalse() : bool
- privateCore() : mixed
- Ejecuta la lógica privada del controlador.
- publicCore() : mixed
- Ejecuta la parte pública del controlador.
- redirect() : mixed
- Redirige a una url o controlador.
- request() : Request
- run() : void
- setTemplate() : bool
- Establece la plantilla a usar para este controlador.
- url() : string
- Devuelve la URL del controlador actual.
- db() : DataBase
- getClassName() : string
- Devuelve el nombre del controlador.
- response() : Response
- setCompany() : void
- Selecciona la empresa indicada, salvo que esté vacía o ya sea la cargada.
- validateFormToken() : bool
- Comprueba el token de la petición. Devuelve un error si: - el token no existe - el token no es válido - el token está duplicado
- getData() : array<string|int, mixed>
- getLimits() : array<string|int, mixed>
- getStorageDetails() : array<string|int, mixed>
Properties
$data
public
array<string|int, mixed>
$data
= []
$empresa
Empresa seleccionada.
public
Empresa
$empresa
$multiRequestProtection
public
MultiRequestProtection
$multiRequestProtection
$permissions
Permisos del usuario sobre este controlador.
public
ControllerPermissions
$permissions
$request
Petición de la que podemos obtener datos.
public
Request
$request
$title
Título de la página.
public
string
$title
título de la página.
$uri
URI dada, por defecto vacía.
public
string
$uri
$user
Usuario que ha iniciado sesión.
public
User|false
$user
= false
$dataBase
Proporciona acceso directo a la base de datos.
protected
DataBase
$dataBase
$response
Objeto de respuesta HTTP.
protected
Response
$response
Methods
__construct()
Inicializa todos los objetos y propiedades.
public
__construct(string $className[, string $uri = '' ]) : mixed
Parameters
- $className : string
- $uri : string = ''
addExtension()
public
static addExtension(mixed $extension) : mixed
Parameters
- $extension : mixed
getPageData()
Devuelve los datos básicos de esta página (nombre, título, icono, menú, etc.).
public
getPageData() : array<string|int, mixed>
Esta función solamente sirve para eso. No se debe añadir aquí ningún otro código, ya que en este punto el usuario ni siquiera se ha logueado todavía.
Return values
array<string|int, mixed>getTemplate()
Devuelve la plantilla a usar para este controlador.
public
getTemplate() : string|false
Return values
string|falsepipe()
public
pipe(string $name, array<string|int, mixed> ...$arguments) : mixed
Parameters
- $name : string
- $arguments : array<string|int, mixed>
pipeFalse()
public
pipeFalse(string $name, array<string|int, mixed> ...$arguments) : bool
Parameters
- $name : string
- $arguments : array<string|int, mixed>
Return values
boolprivateCore()
Ejecuta la lógica privada del controlador.
public
privateCore(mixed &$response, mixed $user, mixed $permissions) : mixed
Parameters
- $response : mixed
- $user : mixed
- $permissions : mixed
publicCore()
Ejecuta la parte pública del controlador.
public
publicCore(Response &$response) : mixed
Parameters
- $response : Response
redirect()
Redirige a una url o controlador.
public
redirect(string $url[, int $delay = 0 ]) : mixed
Parameters
- $url : string
- $delay : int = 0
request()
public
request() : Request
Return values
Requestrun()
public
run() : void
setTemplate()
Establece la plantilla a usar para este controlador.
public
setTemplate(string|false $template) : bool
Parameters
- $template : string|false
Return values
boolurl()
Devuelve la URL del controlador actual.
public
url() : string
Return values
stringdb()
protected
db() : DataBase
Return values
DataBasegetClassName()
Devuelve el nombre del controlador.
protected
getClassName() : string
Return values
stringresponse()
protected
response() : Response
Return values
ResponsesetCompany()
Selecciona la empresa indicada, salvo que esté vacía o ya sea la cargada.
protected
setCompany(int|null $idempresa) : void
Parameters
- $idempresa : int|null
validateFormToken()
Comprueba el token de la petición. Devuelve un error si: - el token no existe - el token no es válido - el token está duplicado
protected
validateFormToken() : bool
Return values
boolgetData()
private
getData() : array<string|int, mixed>
Return values
array<string|int, mixed>getLimits()
private
getLimits() : array<string|int, mixed>
Return values
array<string|int, mixed>getStorageDetails()
private
getStorageDetails() : array<string|int, mixed>