Ejercicio
extends Ejercicio
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'
- EXERCISE_STATUS_CLOSED = 'CERRADO'
- EXERCISE_STATUS_OPEN = 'ABIERTO'
- HOUR_STYLE = 'H:i:s'
- $codejercicio : string
- Primary key. Varchar(4).
- $estado : string
- Exercise status: ABIERTO|CERRADO
- $fechafin : string
- End date of the exercise.
- $fechainicio : string
- Start date of the exercise.
- $idasientoapertura : int
- Opening accounting entry ID.
- $idasientocierre : int
- Accounting entry ID of the year end.
- $idasientopyg : int
- Profit and loss entry ID.
- $idempresa : int
- Foreign Key with Empresas table.
- $longsubcuenta : int
- Length of characters of the subaccounts assigned.
- $nombre : string
- Name of the exercise.
- $checkedTables : array<string|int, mixed>
- List of already tested tables.
- $dataBase : DataBase
- It provides direct access to the database.
- $fields : array<string|int, mixed>
- List of fields in the table.
- __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.
- 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
- getBestFecha() : string
- Returns the date closest to $date that is within the range of this exercise.
- getModelFields() : array<string|int, mixed>
- Returns the list of fields in the table.
- hasAccountingPlan() : bool
- inRange() : bool
- Check if the indicated date is within the period of the exercise dates
- 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.
- isOpened() : bool
- Returns the state of the exercise OPEN -> true | CLOSED -> false
- 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.
- loadFromDate() : bool
- Load the exercise for the indicated date. If it does not exist, create it.
- 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.
- 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.
- url() : string
- Returns the url where to see / modify the data.
- year() : string
- Returns the value of the year of the exercise.
- createNew() : bool
- loadModelFields() : mixed
- Loads table fields if is necessary.
- modelName() : string
- Returns the name of the model.
- saveInsert() : bool
- Insert the model data in the database.
- saveUpdate() : bool
- Update the model data in the database.
- toolBox() : ToolBox
- Returns a new instance of the ToolBox class.
- checkTable() : bool
- Checks and updates the structure of the table if necessary.
- 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'
EXERCISE_STATUS_CLOSED
public
mixed
EXERCISE_STATUS_CLOSED
= 'CERRADO'
EXERCISE_STATUS_OPEN
public
mixed
EXERCISE_STATUS_OPEN
= 'ABIERTO'
HOUR_STYLE
public
mixed
HOUR_STYLE
= 'H:i:s'
Properties
$codejercicio
Primary key. Varchar(4).
public
string
$codejercicio
$estado
Exercise status: ABIERTO|CERRADO
public
string
$estado
$fechafin
End date of the exercise.
public
string
$fechafin
with date format
$fechainicio
Start date of the exercise.
public
string
$fechainicio
with date format
$idasientoapertura
Opening accounting entry ID.
public
int
$idasientoapertura
$idasientocierre
Accounting entry ID of the year end.
public
int
$idasientocierre
$idasientopyg
Profit and loss entry ID.
public
int
$idasientopyg
$idempresa
Foreign Key with Empresas table.
public
int
$idempresa
$longsubcuenta
Length of characters of the subaccounts assigned.
public
int
$longsubcuenta
$nombre
Name of the exercise.
public
string
$nombre
$checkedTables
List of already tested tables.
protected
static array<string|int, mixed>
$checkedTables
= []
$dataBase
It provides direct access to the database.
protected
static DataBase
$dataBase
$fields
List of fields in the table.
protected
static array<string|int, mixed>
$fields
= []
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 —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 —getBestFecha()
Returns the date closest to $date that is within the range of this exercise.
public
getBestFecha(string $fecha[, bool $showError = false ]) : string
Parameters
- $fecha : string
- $showError : bool = false
Return values
string —getModelFields()
Returns the list of fields in the table.
public
abstract getModelFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasAccountingPlan()
public
hasAccountingPlan() : bool
Return values
bool —inRange()
Check if the indicated date is within the period of the exercise dates
public
inRange(string $dateToCheck) : bool
Parameters
- $dateToCheck : string
-
(string with date format)
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 —isOpened()
Returns the state of the exercise OPEN -> true | CLOSED -> false
public
isOpened() : bool
Return values
bool —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 —loadFromDate()
Load the exercise for the indicated date. If it does not exist, create it.
public
loadFromDate(string $date[, bool $onlyOpened = true ][, bool $create = true ]) : bool
Parameters
- $date : string
- $onlyOpened : bool = true
- $create : bool = true
Return values
bool —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 —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> —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 —year()
Returns the value of the year of the exercise.
public
year() : string
Return values
string —en formato año
createNew()
protected
createNew(string $date) : bool
Parameters
- $date : string
Return values
bool —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 —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 —toolBox()
Returns a new instance of the ToolBox class.
protected
static toolBox() : ToolBox
Tags
Return values
ToolBox —checkTable()
Checks and updates the structure of the table if necessary.
private
checkTable() : bool
Return values
bool —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> = []