PurchasesLineModInterface
in
Define los puntos de extensión de las líneas del formulario de documentos de compra.
Table of Contents
Methods
- apply() : void
- Aplica el mod después de procesar las líneas recibidas desde el formulario.
- applyToLine() : void
- Aplica los datos adicionales del mod a una línea recibida desde el formulario.
- assets() : void
- Registra los recursos CSS y JavaScript que necesita el mod.
- getFastLine() : BusinessDocumentLine|null
- Intenta crear una línea para la entrada rápida cuando la búsqueda estándar no encuentra un producto.
- map() : array<string|int, mixed>
- Devuelve valores adicionales de las líneas para actualizar el formulario mediante JavaScript.
- newFields() : array<string|int, string>
- Devuelve los identificadores de las columnas adicionales de cada línea.
- newModalFields() : array<string|int, string>
- Devuelve los identificadores de los campos adicionales del modal de cada línea.
- newTitles() : array<string|int, string>
- Devuelve los identificadores de las cabeceras adicionales de la lista de líneas.
- renderField() : string|null
- Renderiza un campo estándar o adicional de una línea.
- renderTitle() : string|null
- Renderiza una cabecera estándar o adicional de la lista de líneas.
Methods
apply()
Aplica el mod después de procesar las líneas recibidas desde el formulario.
public
apply(PurchaseDocument &$model, array<string|int, BusinessDocumentLine> &$lines, array<string|int, mixed> $formData) : void
Parameters
- $model : PurchaseDocument
- $lines : array<string|int, BusinessDocumentLine>
- $formData : array<string|int, mixed>
-
Datos recibidos desde el formulario.
applyToLine()
Aplica los datos adicionales del mod a una línea recibida desde el formulario.
public
applyToLine(array<string|int, mixed> $formData, BusinessDocumentLine &$line, string $id) : void
El identificador corresponde al ID de la línea o al identificador temporal de una línea nueva.
Parameters
- $formData : array<string|int, mixed>
-
Datos recibidos desde el formulario.
- $line : BusinessDocumentLine
- $id : string
assets()
Registra los recursos CSS y JavaScript que necesita el mod.
public
assets() : void
getFastLine()
Intenta crear una línea para la entrada rápida cuando la búsqueda estándar no encuentra un producto.
public
getFastLine(PurchaseDocument $model, array<string|int, mixed> $formData) : BusinessDocumentLine|null
Devuelve null cuando el mod no puede resolver la entrada.
Parameters
- $model : PurchaseDocument
- $formData : array<string|int, mixed>
-
Datos recibidos desde el formulario.
Return values
BusinessDocumentLine|nullmap()
Devuelve valores adicionales de las líneas para actualizar el formulario mediante JavaScript.
public
map(array<string|int, BusinessDocumentLine> $lines, PurchaseDocument $model) : array<string|int, mixed>
Parameters
- $lines : array<string|int, BusinessDocumentLine>
- $model : PurchaseDocument
Return values
array<string|int, mixed>newFields()
Devuelve los identificadores de las columnas adicionales de cada línea.
public
newFields() : array<string|int, string>
Return values
array<string|int, string>newModalFields()
Devuelve los identificadores de los campos adicionales del modal de cada línea.
public
newModalFields() : array<string|int, string>
Return values
array<string|int, string>newTitles()
Devuelve los identificadores de las cabeceras adicionales de la lista de líneas.
public
newTitles() : array<string|int, string>
Return values
array<string|int, string>renderField()
Renderiza un campo estándar o adicional de una línea.
public
renderField(string $idlinea, BusinessDocumentLine $line, PurchaseDocument $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 : BusinessDocumentLine
- $model : PurchaseDocument
- $field : string
Return values
string|nullrenderTitle()
Renderiza una cabecera estándar o adicional de la lista de líneas.
public
renderTitle(PurchaseDocument $model, string $field) : string|null
Devuelve null cuando el mod no gestiona la cabecera para permitir que otro mod la renderice.
Parameters
- $model : PurchaseDocument
- $field : string