BusinessDocumentLine
extends BusinessDocumentLine
in package
Class created by Core/Base/PluginDeploy
Tags
Table of Contents
- AUDIT_CHANNEL = 'audit'
- DATE_STYLE = 'd-m-Y'
- DATETIME_STYLE = 'd-m-Y H:i:s'
- HOUR_STYLE = 'H:i:s'
- $actualizastock : int
- Update stock status.
- $cantidad : float|int
- Quantity.
- $codimpuesto : string
- Tax identifier of the tax assigned.
- $descripcion : string
- Description of the line.
- $dtopor : float|int
- Percentage of discount.
- $dtopor2 : float|int
- Percentage of second discount.
- $excepcioniva : string
- $idlinea : int
- Primary key.
- $idproducto : int
- $irpf : float|int
- % of IRPF of the line.
- $iva : float|int
- % of the related tax.
- $orden : int
- Position of the line in the document. The higher down.
- $pvpsindto : float|int
- Net amount without discounts.
- $pvptotal : float|int
- Net amount of the line, without taxes.
- $pvpunitario : float|int
- Price of the item, one unit.
- $recargo : float|int
- % surcharge of line equivalence.
- $referencia : string
- Reference of the article.
- $servido : float|int
- Served.
- $suplido : bool
- $dataBase : DataBase
- It provides direct access to the database.
- $dont_copy_fields : array<string|int, mixed>
- $previousData : array<string|int, mixed>
- Previous data array.
- $disableUpdateStock : bool
- __construct() : mixed
- ModelClass constructor.
- addExtension() : mixed
- Adds an extension to this model.
- all() : array<string|int, static>
- Returns all models that correspond to the selected filters.
- changePrimaryColumnValue() : bool
- Change the value of the primary column in the model and the database.
- clear() : mixed
- Reset the values of all model properties.
- codeModelAll() : array<string|int, CodeModel>
- Allows to use this model as source in CodeModel special model.
- codeModelSearch() : array<string|int, CodeModel>
- Allows to use this model as source in CodeModel special model.
- count() : int
- Returns the number of records in the model that meet the condition.
- delete() : bool
- Remove the model data from the database.
- disableUpdateStock() : void
- documentColumn() : mixed
- Returns the name of the column to store the document's identifier.
- documentColumnValue() : int
- Returns the identifier of the document.
- dontCopyField() : void
- dontCopyFields() : array<string|int, mixed>
- exists() : bool
- Returns true if the model data is stored in the database.
- get() : static|false
- Returns the model whose primary column corresponds to the value $cod
- getDisableUpdateStock() : bool
- getDocument() : mixed
- Returns the parent document of this line.
- getEUDiscount() : float
- Returns the Equivalent Unified Discount.
- getModelFields() : array<string|int, mixed>
- Returns the list of fields in the table.
- getProducto() : Producto
- getTax() : Impuesto
- Returns the current tax or the default one
- getVariante() : Variante
- hasChanged() : bool
- install() : string
- This function is called when creating the model table. Returns the SQL that will be executed after the creation of the table. Useful to insert values default.
- loadFromCode() : bool
- Fill the class with the registry values whose primary column corresponds to the value $cod, or according to the condition where indicated, if value is not reported in $cod.
- loadFromData() : mixed
- Assign the values of the $data array to the model properties.
- modelClassName() : string
- Returns the name of the class of the model.
- newCode() : int
- Returns the following code for the reported field or the primary key of the model.
- pipe() : mixed
- Executes all $name methods added from the extensions.
- pipeFalse() : bool
- Executes all $name methods added from the extensions until someone returns false.
- primaryColumn() : string
- Returns the name of the column that is the model's primary key.
- primaryColumnValue() : mixed
- Returns the current value of the main column of the model.
- primaryDescription() : string
- Descriptive identifier for humans of the data record
- primaryDescriptionColumn() : string
- Returns the name of the column that describes the model, such as name, description.
- save() : bool
- Stores the model data in the database.
- setPriceWithTax() : void
- table() : DbQuery
- tableName() : string
- Returns the name of the table that uses this model.
- test() : bool
- Returns true if there are no errors in the values of the model properties.
- toArray() : array<string|int, mixed>
- Returns an array with the model fields values.
- totalSum() : float
- transfer() : bool
- Transfers the line stock from one warehouse to another.
- url() : string
- Returns the url where to see / modify the data.
- loadModelFields() : mixed
- Loads table fields if is necessary.
- modelName() : string
- Returns the name of the model.
- onChange() : bool
- This method is called before save (update) when some field has changed.
- onDelete() : mixed
- This method is called after a record is removed from the database.
- onInsert() : mixed
- This method is called after a new record is saved on the database (saveInsert).
- onUpdate() : mixed
- This method is called after a record is updated on the database (saveUpdate).
- saveInsert() : bool
- Insert the model data in the database.
- saveUpdate() : bool
- Update the model data in the database.
- setPreviousData() : mixed
- Saves previous values.
- toolBox() : ToolBox
- Returns a new instance of the ToolBox class.
- updateStock() : bool
- Updates stock according to line data and $codalmacen warehouse.
- applyStockChanges() : mixed
- Apply stock modifications according to $mode.
- getBoolValueForField() : bool|null
- Returns the boolean value for the field.
- getFloatValueForField() : float|null
- Returns the float value for the field.
- getIntegerValueForField() : int|null
- Returns the integer value by controlling special cases for the PK and FK.
- getOrderBy() : string
- Convert an array of filters order by in string.
- getRecord() : array<string|int, mixed>
- Read the record whose primary column corresponds to the value $cod or the first that meets the indicated condition.
Constants
AUDIT_CHANNEL
public
mixed
AUDIT_CHANNEL
= 'audit'
DATE_STYLE
public
mixed
DATE_STYLE
= 'd-m-Y'
DATETIME_STYLE
public
mixed
DATETIME_STYLE
= 'd-m-Y H:i:s'
HOUR_STYLE
public
mixed
HOUR_STYLE
= 'H:i:s'
Properties
$actualizastock
Update stock status.
public
int
$actualizastock
$cantidad
Quantity.
public
float|int
$cantidad
$codimpuesto
Tax identifier of the tax assigned.
public
string
$codimpuesto
$descripcion
Description of the line.
public
string
$descripcion
$dtopor
Percentage of discount.
public
float|int
$dtopor
$dtopor2
Percentage of second discount.
public
float|int
$dtopor2
$excepcioniva
public
string
$excepcioniva
$idlinea
Primary key.
public
int
$idlinea
$idproducto
public
int
$idproducto
$irpf
% of IRPF of the line.
public
float|int
$irpf
$iva
% of the related tax.
public
float|int
$iva
$orden
Position of the line in the document. The higher down.
public
int
$orden
$pvpsindto
Net amount without discounts.
public
float|int
$pvpsindto
$pvptotal
Net amount of the line, without taxes.
public
float|int
$pvptotal
$pvpunitario
Price of the item, one unit.
public
float|int
$pvpunitario
$recargo
% surcharge of line equivalence.
public
float|int
$recargo
$referencia
Reference of the article.
public
string
$referencia
$servido
Served.
public
float|int
$servido
$suplido
public
bool
$suplido
$dataBase
It provides direct access to the database.
protected
static DataBase
$dataBase
$dont_copy_fields
protected
static array<string|int, mixed>
$dont_copy_fields
= ['idlinea', 'orden', 'servido']
$previousData
Previous data array.
protected
array<string|int, mixed>
$previousData
= []
$disableUpdateStock
private
bool
$disableUpdateStock
= false
Methods
__construct()
ModelClass constructor.
public
__construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
Return values
mixed —addExtension()
Adds an extension to this model.
public
abstract static addExtension(mixed $extension) : mixed
Parameters
- $extension : mixed
Return values
mixed —all()
Returns all models that correspond to the selected filters.
public
static all([array<string|int, mixed> $where = [] ][, array<string|int, mixed> $order = [] ], int $offset[, int $limit = 50 ]) : array<string|int, static>
Parameters
- $where : array<string|int, mixed> = []
-
filters to apply to model records.
- $order : array<string|int, mixed> = []
-
fields to use in the sorting. For example ['code' => 'ASC']
- $offset : int
- $limit : int = 50
Return values
array<string|int, static> —changePrimaryColumnValue()
Change the value of the primary column in the model and the database.
public
changePrimaryColumnValue(mixed $newValue) : bool
Parameters
- $newValue : mixed
Return values
bool —clear()
Reset the values of all model properties.
public
clear() : mixed
Return values
mixed —codeModelAll()
Allows to use this model as source in CodeModel special model.
public
codeModelAll([string $fieldCode = '' ]) : array<string|int, CodeModel>
Parameters
- $fieldCode : string = ''
Return values
array<string|int, CodeModel> —codeModelSearch()
Allows to use this model as source in CodeModel special model.
public
codeModelSearch(string $query[, string $fieldCode = '' ][, array<string|int, DataBaseWhere> $where = [] ]) : array<string|int, CodeModel>
Parameters
- $query : string
- $fieldCode : string = ''
- $where : array<string|int, DataBaseWhere> = []
Return values
array<string|int, CodeModel> —count()
Returns the number of records in the model that meet the condition.
public
count([array<string|int, DataBaseWhere> $where = [] ]) : int
Parameters
- $where : array<string|int, DataBaseWhere> = []
-
filters to apply to model records.
Return values
int —delete()
Remove the model data from the database.
public
delete() : bool
Return values
bool —disableUpdateStock()
public
disableUpdateStock(bool $value) : void
Parameters
- $value : bool
Return values
void —documentColumn()
Returns the name of the column to store the document's identifier.
public
abstract documentColumn() : mixed
Return values
mixed —documentColumnValue()
Returns the identifier of the document.
public
documentColumnValue() : int
Return values
int —dontCopyField()
public
static dontCopyField(string $field) : void
Parameters
- $field : string
Return values
void —dontCopyFields()
public
static dontCopyFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —exists()
Returns true if the model data is stored in the database.
public
exists() : bool
Return values
bool —get()
Returns the model whose primary column corresponds to the value $cod
public
get(string $code) : static|false
Parameters
- $code : string
Return values
static|false —getDisableUpdateStock()
public
getDisableUpdateStock() : bool
Return values
bool —getDocument()
Returns the parent document of this line.
public
abstract getDocument() : mixed
Return values
mixed —getEUDiscount()
Returns the Equivalent Unified Discount.
public
getEUDiscount() : float
Return values
float —getModelFields()
Returns the list of fields in the table.
public
abstract getModelFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProducto()
public
getProducto() : Producto
Return values
Producto —getTax()
Returns the current tax or the default one
public
getTax() : Impuesto
Return values
Impuesto —getVariante()
public
getVariante() : Variante
Return values
Variante —hasChanged()
public
hasChanged(string $field) : bool
Parameters
- $field : string
Return values
bool —install()
This function is called when creating the model table. Returns the SQL that will be executed after the creation of the table. Useful to insert values default.
public
install() : string
Return values
string —loadFromCode()
Fill the class with the registry values whose primary column corresponds to the value $cod, or according to the condition where indicated, if value is not reported in $cod.
public
loadFromCode(string $code[, array<string|int, mixed> $where = [] ][, array<string|int, mixed> $order = [] ]) : bool
Initializes the values of the class if there is no record that meet the above conditions. Returns True if the record exists and False otherwise.
Parameters
- $code : string
- $where : array<string|int, mixed> = []
- $order : array<string|int, mixed> = []
Return values
bool —loadFromData()
Assign the values of the $data array to the model properties.
public
loadFromData([array<string|int, mixed> $data = [] ][, array<string|int, mixed> $exclude = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
- $exclude : array<string|int, mixed> = []
Return values
mixed —modelClassName()
Returns the name of the class of the model.
public
abstract modelClassName() : string
Return values
string —newCode()
Returns the following code for the reported field or the primary key of the model.
public
newCode([string $field = '' ][, array<string|int, mixed> $where = [] ]) : int
Parameters
- $field : string = ''
- $where : array<string|int, mixed> = []
Return values
int —pipe()
Executes all $name methods added from the extensions.
public
abstract pipe(string $name, array<string|int, mixed> ...$arguments) : mixed
Parameters
- $name : string
- $arguments : array<string|int, mixed>
Return values
mixed —pipeFalse()
Executes all $name methods added from the extensions until someone returns false.
public
abstract pipeFalse(string $name, array<string|int, mixed> ...$arguments) : bool
Parameters
- $name : string
- $arguments : array<string|int, mixed>
Return values
bool —primaryColumn()
Returns the name of the column that is the model's primary key.
public
abstract static primaryColumn() : string
Return values
string —primaryColumnValue()
Returns the current value of the main column of the model.
public
primaryColumnValue() : mixed
Return values
mixed —primaryDescription()
Descriptive identifier for humans of the data record
public
primaryDescription() : string
Return values
string —primaryDescriptionColumn()
Returns the name of the column that describes the model, such as name, description.
public
primaryDescriptionColumn() : string
..
Return values
string —save()
Stores the model data in the database.
public
save() : bool
Return values
bool —setPriceWithTax()
public
setPriceWithTax(float $price) : void
Parameters
- $price : float
Return values
void —table()
public
static table() : DbQuery
Return values
DbQuery —tableName()
Returns the name of the table that uses this model.
public
abstract static tableName() : string
Return values
string —test()
Returns true if there are no errors in the values of the model properties.
public
test() : bool
It runs inside the save method.
Return values
bool —toArray()
Returns an array with the model fields values.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —totalSum()
public
totalSum(string $field[, array<string|int, mixed> $where = [] ]) : float
Parameters
- $field : string
- $where : array<string|int, mixed> = []
Return values
float —transfer()
Transfers the line stock from one warehouse to another.
public
transfer(string $fromCodalmacen, string $toCodalmacen) : bool
Parameters
- $fromCodalmacen : string
- $toCodalmacen : string
Return values
bool —url()
Returns the url where to see / modify the data.
public
url([string $type = 'auto' ][, string $list = 'List' ]) : string
Parameters
- $type : string = 'auto'
- $list : string = 'List'
Return values
string —loadModelFields()
Loads table fields if is necessary.
protected
abstract loadModelFields(DataBase &$dataBase, string $tableName) : mixed
Parameters
- $dataBase : DataBase
- $tableName : string
Return values
mixed —modelName()
Returns the name of the model.
protected
abstract modelName() : string
Return values
string —onChange()
This method is called before save (update) when some field has changed.
protected
onChange(string $field) : bool
Parameters
- $field : string
Return values
bool —onDelete()
This method is called after a record is removed from the database.
protected
onDelete() : mixed
Return values
mixed —onInsert()
This method is called after a new record is saved on the database (saveInsert).
protected
onInsert() : mixed
Return values
mixed —onUpdate()
This method is called after a record is updated on the database (saveUpdate).
protected
onUpdate() : mixed
Return values
mixed —saveInsert()
Insert the model data in the database.
protected
saveInsert([array<string|int, mixed> $values = [] ]) : bool
Parameters
- $values : array<string|int, mixed> = []
Return values
bool —saveUpdate()
Update the model data in the database.
protected
saveUpdate([array<string|int, mixed> $values = [] ]) : bool
Parameters
- $values : array<string|int, mixed> = []
Return values
bool —setPreviousData()
Saves previous values.
protected
setPreviousData([array<string|int, mixed> $fields = [] ]) : mixed
Parameters
- $fields : array<string|int, mixed> = []
Return values
mixed —toolBox()
Returns a new instance of the ToolBox class.
protected
static toolBox() : ToolBox
Tags
Return values
ToolBox —updateStock()
Updates stock according to line data and $codalmacen warehouse.
protected
updateStock() : bool
Return values
bool —applyStockChanges()
Apply stock modifications according to $mode.
private
applyStockChanges(Stock &$stock, int $mode, float $quantity, float $served) : mixed
Parameters
- $stock : Stock
- $mode : int
- $quantity : float
- $served : float
Return values
mixed —getBoolValueForField()
Returns the boolean value for the field.
private
getBoolValueForField(array<string|int, mixed> $field, mixed $value) : bool|null
Parameters
- $field : array<string|int, mixed>
- $value : mixed
Return values
bool|null —getFloatValueForField()
Returns the float value for the field.
private
getFloatValueForField(array<string|int, mixed> $field, string $value) : float|null
Parameters
- $field : array<string|int, mixed>
- $value : string
Return values
float|null —getIntegerValueForField()
Returns the integer value by controlling special cases for the PK and FK.
private
getIntegerValueForField(array<string|int, mixed> $field, string $value) : int|null
Parameters
- $field : array<string|int, mixed>
- $value : string
Return values
int|null —getOrderBy()
Convert an array of filters order by in string.
private
static getOrderBy(array<string|int, mixed> $order) : string
Parameters
- $order : array<string|int, mixed>
Return values
string —getRecord()
Read the record whose primary column corresponds to the value $cod or the first that meets the indicated condition.
private
getRecord(string $code[, array<string|int, mixed> $where = [] ][, array<string|int, mixed> $order = [] ]) : array<string|int, mixed>
Parameters
- $code : string
- $where : array<string|int, mixed> = []
- $order : array<string|int, mixed> = []