FacturaScripts

PurchasesModInterface

Define los puntos de extensión de la cabecera y el pie de los documentos de compra.

Table of Contents

Methods

apply()  : void
Ejecuta la fase posterior del mod, una vez procesados los campos estándar cuando corresponda.
applyBefore()  : void
Ejecuta la fase previa del mod antes de procesar los campos estándar del formulario.
assets()  : void
Registra los recursos CSS y JavaScript que necesita el mod.
newBtnFields()  : array<string|int, string>
Devuelve los identificadores de los botones adicionales de la cabecera o el pie.
newFields()  : array<string|int, string>
Devuelve los identificadores de los campos adicionales de la cabecera o el pie.
newModalFields()  : array<string|int, string>
Devuelve los identificadores de los campos adicionales del modal de la cabecera o el pie.
renderField()  : string|null
Renderiza un campo estándar o adicional del formulario.

Methods

apply()

Ejecuta la fase posterior del mod, una vez procesados los campos estándar cuando corresponda.

public apply(PurchaseDocument &$model, array<string|int, mixed> $formData) : void
Parameters
$model : PurchaseDocument
$formData : array<string|int, mixed>

Datos recibidos desde el formulario.

applyBefore()

Ejecuta la fase previa del mod antes de procesar los campos estándar del formulario.

public applyBefore(PurchaseDocument &$model, array<string|int, mixed> $formData) : void
Parameters
$model : PurchaseDocument
$formData : array<string|int, mixed>

Datos recibidos desde el formulario.

newBtnFields()

Devuelve los identificadores de los botones adicionales de la cabecera o el pie.

public newBtnFields() : array<string|int, string>

Cada identificador se enviará posteriormente a renderField().

Return values
array<string|int, string>

newFields()

Devuelve los identificadores de los campos adicionales de la cabecera o el pie.

public newFields() : array<string|int, string>

Cada identificador se enviará posteriormente a renderField().

Return values
array<string|int, string>

newModalFields()

Devuelve los identificadores de los campos adicionales del modal de la cabecera o el pie.

public newModalFields() : array<string|int, string>

Cada identificador se enviará posteriormente a renderField().

Return values
array<string|int, string>

renderField()

Renderiza un campo estándar o adicional del formulario.

public renderField(PurchaseDocument $model, string $field) : string|null

Devuelve null cuando el mod no gestiona el campo para permitir que otro mod lo renderice.

Parameters
$model : PurchaseDocument
$field : string
Return values
string|null
On this page

Search results