FacturaScripts

Controller
in package
implements ControllerInterface

Clase de la que deben heredar todos los controladores de FacturaScripts.

Table of Contents

Interfaces

ControllerInterface
Define el contrato básico de los controladores ejecutados por el kernel.

Properties

$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.
$className  : string
Nombre de la clase del controlador (aunque herede de esta clase, aquí tendremos el nombre de la clase final).
$template  : string|false
Nombre del archivo de la plantilla.

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
Ejecuta el ciclo principal del controlador para procesar la petición actual.
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
auth()  : bool
checkPhpVersion()  : void

Properties

$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

$className

Nombre de la clase del controlador (aunque herede de esta clase, aquí tendremos el nombre de la clase final).

private string $className

CLASS

$template

Nombre del archivo de la plantilla.

private string|false $template

nombre_archivo.html.twig

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|false

pipe()

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
bool

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

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.

setTemplate()

Establece la plantilla a usar para este controlador.

public setTemplate(string|false $template) : bool
Parameters
$template : string|false
Return values
bool

url()

Devuelve la URL del controlador actual.

public url() : string
Return values
string

getClassName()

Devuelve el nombre del controlador.

protected getClassName() : string
Return values
string

setCompany()

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
bool

auth()

private auth() : bool
Return values
bool

checkPhpVersion()

private checkPhpVersion(float $min) : void
Parameters
$min : float
On this page

Search results