FacturaScripts

MegaSearch extends Controller
in package

Controller to perform searches on the page

Table of Contents

Properties

$empresa  : Empresa
Empresa seleccionada.
$multiRequestProtection  : MultiRequestProtection
$permissions  : ControllerPermissions
Permisos del usuario sobre este controlador.
$query  : string|false
This variable contains the input text as the $query parameter to be used to filter the model data
$request  : Request
Petición de la que podemos obtener datos.
$results  : array<string|int, mixed>
Results by page
$sections  : array<string|int, mixed>
More sections to search in
$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
Runs the controller's private logic.
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.
pageSearch()  : void
Proceeds to search in the whole page
response()  : Response
search()  : void
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

Properties

$query

This variable contains the input text as the $query parameter to be used to filter the model data

public string|false $query

$results

Results by page

public array<string|int, mixed> $results

$sections

More sections to search in

public array<string|int, mixed> $sections

$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

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

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

pageSearch()

Proceeds to search in the whole page

protected pageSearch() : void

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
On this page

Search results