FacturaScripts

AccountingLineModInterface

Define los puntos de extensión de las partidas del formulario de asientos.

Table of Contents

Methods

apply()  : void
Aplica el mod después de procesar las partidas recibidas desde el formulario.
applyToLine()  : void
Aplica los datos adicionales del mod a una partida recibida desde el formulario.
assets()  : void
Registra los recursos CSS y JavaScript que necesita el mod.
newFields()  : array<string|int, string>
Devuelve los identificadores de las columnas adicionales de cada partida.
newModalFields()  : array<string|int, string>
Devuelve los identificadores de los campos adicionales del modal de cada partida.
renderField()  : string|null
Renderiza un campo estándar o adicional de una partida.

Methods

apply()

Aplica el mod después de procesar las partidas recibidas desde el formulario.

public apply(Asiento &$model, array<string|int, Partida> &$lines, array<string|int, mixed> $formData) : void

Puede modificar el asiento y sus partidas; los totales se recalculan después de ejecutar todos los mods.

Parameters
$model : Asiento
$lines : array<string|int, Partida>
$formData : array<string|int, mixed>

Datos recibidos desde el formulario.

applyToLine()

Aplica los datos adicionales del mod a una partida recibida desde el formulario.

public applyToLine(array<string|int, mixed> $formData, Partida &$line, string $id) : void

El identificador corresponde al ID de la partida o al identificador temporal de una partida nueva.

Parameters
$formData : array<string|int, mixed>

Datos recibidos desde el formulario.

$line : Partida
$id : string

newFields()

Devuelve los identificadores de las columnas adicionales de cada partida.

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 cada partida.

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 de una partida.

public renderField(string $idlinea, Partida $line, Asiento $model, string $field) : string|null

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

Parameters
$idlinea : string
$line : Partida
$model : Asiento
$field : string
Return values
string|null
On this page

Search results