FacturaScripts

DocumentStitcher extends DocumentStitcher
in package
uses ExtensionsTrait

Class created by Core/Internal/PluginsDeploy

Table of Contents

Constants

MODEL_NAMESPACE  : mixed = '\FacturaScripts\Dinamic\Model\\'

Properties

$codes  : array<string|int, mixed>
$documents  : array<string|int, TransformerDocument>
$empresa  : Empresa
Empresa seleccionada.
$filters  : array<string|int, mixed>
$modelName  : string
$moreDocuments  : array<string|int, TransformerDocument>
$multiRequestProtection  : MultiRequestProtection
$payMethods  : array<string|int, mixed>
$permissions  : ControllerPermissions
Permisos del usuario sobre este controlador.
$request  : Request
Petición de la que podemos obtener datos.
$showFilters  : bool
$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.
$where  : array<string|int, mixed>
$dataBase  : DataBase
Proporciona acceso directo a la base de datos.
$extensionCache  : array<string|int, mixed>
Cache for extension lookups by method name.
$extensions  : array<string|int, mixed>
Stores class extensions.
$response  : Response
Objeto de respuesta HTTP.

Methods

__call()  : mixed
Executes the first matched extension.
__construct()  : mixed
Inicializa todos los objetos y propiedades.
addExtension()  : void
clearExtensions()  : void
Clears all registered extensions.
getAvailableStatus()  : array<string|int, mixed>
getExtensions()  : array<string|int, mixed>
Returns a list of all registered extension names.
getPageData()  : array<string|int, mixed>
Devuelve los datos básicos de esta página (nombre, título, icono, menú, etc.).
getSeries()  : array<string|int, mixed>
getTemplate()  : string|false
Devuelve la plantilla a usar para este controlador.
hasExtension()  : bool
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.
removeExtension()  : bool
Removes all extensions with the specified name.
request()  : Request
run()  : void
setTemplate()  : bool
Establece la plantilla a usar para este controlador.
url()  : string
Devuelve la URL del controlador actual.
addBlankLine()  : void
addDocument()  : bool
addFilters()  : void
addInfoLine()  : void
breakDownLines()  : bool
checkOwnerData()  : bool
Returns true if the active user has permission to view the information of the active record in the informed model.
closeDocuments()  : void
db()  : DataBase
generateNewDocument()  : void
Genera un nuevo documento con estos datos.
getClassName()  : string
Devuelve el nombre del controlador.
getCodes()  : array<string|int, mixed>
Devuelve las claves de los documentos.
getDocInfoLineDescription()  : string
getGenerateClass()  : string|null
Devuelve el nombre de la nueva clase a generar a partir de este estado.
getModelName()  : string
Devuelve el nombre del modelo.
loadDocuments()  : void
Carga los documentos seleccionados.
loadMoreDocuments()  : void
processFormDataLoad()  : void
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
validateSelectedQuantities()  : bool
buildExtensionCache()  : void
Builds and caches sorted extensions for a method name.

Constants

MODEL_NAMESPACE

public mixed MODEL_NAMESPACE = '\FacturaScripts\Dinamic\Model\\'

Properties

$filters

public array<string|int, mixed> $filters = ['codpago' => '', 'desde' => '', 'hasta' => '']

$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

$extensionCache

Cache for extension lookups by method name.

protected static array<string|int, mixed> $extensionCache = []

$extensions

Stores class extensions.

protected static array<string|int, mixed> $extensions = []

Methods

__call()

Executes the first matched extension.

public __call(string $name[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed> = []
Tags
throws
BadMethodCallException

__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[, int $priority = 100 ]) : void
Parameters
$extension : mixed
$priority : int = 100

Priority for all methods in this extension (0-1000, default 100)

clearExtensions()

Clears all registered extensions.

public static clearExtensions() : void

getAvailableStatus()

public getAvailableStatus() : array<string|int, mixed>
Return values
array<string|int, mixed>

getExtensions()

Returns a list of all registered extension names.

public static getExtensions() : array<string|int, mixed>
Return values
array<string|int, 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>

getSeries()

public getSeries() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTemplate()

Devuelve la plantilla a usar para este controlador.

public getTemplate() : string|false
Return values
string|false

hasExtension()

public hasExtension(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

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

removeExtension()

Removes all extensions with the specified name.

public static removeExtension(string $name) : bool
Parameters
$name : string
Return values
bool —

True if at least one extension was removed

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

breakDownLines()

protected breakDownLines(TransformerDocument &$doc, array<string|int, mixed> &$docLines, array<string|int, mixed> &$newLines, array<string|int, mixed> &$quantities, int $idestado) : bool
Parameters
$doc : TransformerDocument
$docLines : array<string|int, mixed>
$newLines : array<string|int, mixed>
$quantities : array<string|int, mixed>
$idestado : int
Return values
bool

checkOwnerData()

Returns true if the active user has permission to view the information of the active record in the informed model.

protected checkOwnerData(ModelClass $model) : bool
Parameters
$model : ModelClass
Return values
bool

closeDocuments()

protected closeDocuments(int $idestado) : void
Parameters
$idestado : int

generateNewDocument()

Genera un nuevo documento con estos datos.

protected generateNewDocument(int $idestado) : void
Parameters
$idestado : int

getClassName()

Devuelve el nombre del controlador.

protected getClassName() : string
Return values
string

getCodes()

Devuelve las claves de los documentos.

protected getCodes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGenerateClass()

Devuelve el nombre de la nueva clase a generar a partir de este estado.

protected getGenerateClass(int $idestado) : string|null
Parameters
$idestado : int
Return values
string|null

getModelName()

Devuelve el nombre del modelo.

protected getModelName() : string
Return values
string

loadDocuments()

Carga los documentos seleccionados.

protected loadDocuments() : 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

validateSelectedQuantities()

protected validateSelectedQuantities() : bool
Return values
bool

buildExtensionCache()

Builds and caches sorted extensions for a method name.

private buildExtensionCache(string $name) : void
Parameters
$name : string
On this page

Search results