PageOption extends PageOption
Class created by Core/Base/PluginManager
Table of Contents
| $columns | Definition of the columns. It is called columns but it always contains GroupItem, which contains the columns. | array |
|---|---|---|
| $id | Identifier | int |
| $modals | Definition of modal forms | array |
| $name | Name of the page (controller). | string |
| $nick | User Identifier. | string |
| $rows | Definition for special treatment of rows | array |
| $fields | List of fields in the table. | array |
| $checkedTables | List of already tested tables. | array |
| $dataBase | It provides direct access to the database. | DataBase |
| clear() | Reset the values of all model properties. | mixed |
| 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. | string |
| loadFromData() | Assign the values of the $data array to the model properties. | mixed |
| primaryColumn() | Returns the name of the column that is the model's primary key. | string |
| tableName() | Returns the name of the table that uses this model. | string |
| getEncodeValues() | Returns the values of the view configuration fields in JSON format | array |
| saveInsert() | Insert the model data in the database. | bool |
| saveUpdate() | Update the model data in the database. | bool |
| getModelFields() | Returns the list of fields in the table. | array |
| modelClassName() | Returns the name of the class of the model. | string |
| modelName() | Returns the name of the model. | string |
| loadModelFields() | Loads table fields if is necessary. | mixed |
| all() | Returns all models that correspond to the selected filters. | static[] |
| codeModelAll() | Allows to use this model as source in CodeModel special model. | \FacturaScripts\Dinamic\Model\CodeModel[] |
| codeModelSearch() | Allows to use this model as source in CodeModel special model. | \FacturaScripts\Dinamic\Model\CodeModel[] |
| count() | Returns the number of records in the model that meet the condition. | int |
| delete() | Remove the model data from the database. | bool |
| exists() | Returns true if the model data is stored in the database. | bool |
| get() | Returns the model whose primary column corresponds to the value $cod | static|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. | bool |
| newCode() | Returns the following code for the reported field or the primary key of the model. | int |
| primaryDescriptionColumn() | Returns the name of the column that describes the model, such as name, description. | string |
| primaryDescription() | Descriptive identifier for humans of the data record | string |
| save() | Stores the model data in the database. | bool |
| test() | Returns true if there are no errors in the values of the model properties. | bool |
| url() | Returns the url where to see / modify the data. | string |
| getOrderBy() | Convert an array of filters order by in string. | string |
| getRecord() | Read the record whose primary column corresponds to the value $cod or the first that meets the indicated condition. | array |
| addExtension() | Adds an extension to this model. | mixed |
| pipe() | Executes all $name methods added from the extensions. | mixed |
| __construct() | ModelClass constructor. | mixed |
| changePrimaryColumnValue() | Change the value of the primary column in the model and the database. | bool |
| primaryColumnValue() | Returns the current value of the main column of the model. | mixed |
| toArray() | Returns an array with the model fields values. | array |
| checkTable() | Checks and updates the structure of the table if necessary. | bool |
| getBoolValueForField() | Returns the boolean value for the field. | bool|null |
| getFloatValueForField() | Returns the float value for the field. | float|null |
| getIntegerValueForField() | Returns the integer value by controlling special cases for the PK and FK. | int|null |
| toolBox() | ToolBox |
Properties
$columns
Definition of the columns. It is called columns but it always contains GroupItem, which contains the columns.
public
array
$columns
$id
Identifier
public
int
$id
$modals
Definition of modal forms
public
array
$modals
$name
Name of the page (controller).
public
string
$name
$nick
User Identifier.
public
string
$nick
$rows
Definition for special treatment of rows
public
array
$rows
$fields
List of fields in the table.
protected
static array
$fields
= []
$checkedTables
List of already tested tables.
private
static array
$checkedTables
= []
$dataBase
It provides direct access to the database.
protected
static DataBase
$dataBase
Methods
clear()
Reset the values of all model properties.
public
clear(
)
: mixed
Return values
mixedinstall()
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
stringloadFromData()
Assign the values of the $data array to the model properties.
public
loadFromData(
[ $data :
array
= [] ]
[, $exclude :
array
= [] ]
)
: mixed
Parameters
- $data : array = []
- $exclude : array = []
Return values
mixedprimaryColumn()
Returns the name of the column that is the model's primary key.
public
abstract static primaryColumn(
)
: string
Return values
stringtableName()
Returns the name of the table that uses this model.
public
abstract static tableName(
)
: string
Return values
stringgetEncodeValues()
Returns the values of the view configuration fields in JSON format
private
getEncodeValues(
)
: array
Return values
arraysaveInsert()
Insert the model data in the database.
protected
saveInsert(
[ $values :
array
= [] ]
)
: bool
Parameters
- $values : array = []
Return values
boolsaveUpdate()
Update the model data in the database.
protected
saveUpdate(
[ $values :
array
= [] ]
)
: bool
Parameters
- $values : array = []
Return values
boolgetModelFields()
Returns the list of fields in the table.
public
abstract getModelFields(
)
: array
Return values
arraymodelClassName()
Returns the name of the class of the model.
public
abstract modelClassName(
)
: string
Return values
stringmodelName()
Returns the name of the model.
protected
abstract modelName(
)
: string
Return values
stringloadModelFields()
Loads table fields if is necessary.
protected
abstract loadModelFields(
&$dataBase :
DataBase
, $tableName :
string
)
: mixed
Parameters
- $dataBase : DataBase
- $tableName : string
Return values
mixedall()
Returns all models that correspond to the selected filters.
public
all(
[ $where :
array
= [] ]
[, $order :
array
= [] ]
, $offset :
int
[, $limit :
int
= 50 ]
)
: static[]
Parameters
- $where : array = []
filters to apply to model records.
- $order : array = []
fields to use in the sorting. For example ['code' => 'ASC']
- $offset : int
- $limit : int = 50
Return values
static[]codeModelAll()
Allows to use this model as source in CodeModel special model.
public
codeModelAll(
[ $fieldCode :
string
= '' ]
)
: \FacturaScripts\Dinamic\Model\CodeModel[]
Parameters
- $fieldCode : string = ''
Return values
\FacturaScripts\Dinamic\Model\CodeModel[]codeModelSearch()
Allows to use this model as source in CodeModel special model.
public
codeModelSearch(
$query :
string
[, $fieldCode :
string
= '' ]
[, $where :
\FacturaScripts\Core\Base\DataBase\DataBaseWhere[]
= [] ]
)
: \FacturaScripts\Dinamic\Model\CodeModel[]
Parameters
- $query : string
- $fieldCode : string = ''
- $where : \FacturaScripts\Core\Base\DataBase\DataBaseWhere[] = []
Return values
\FacturaScripts\Dinamic\Model\CodeModel[]count()
Returns the number of records in the model that meet the condition.
public
count(
[ $where :
\FacturaScripts\Core\Base\DataBase\DataBaseWhere[]
= [] ]
)
: int
Parameters
- $where : \FacturaScripts\Core\Base\DataBase\DataBaseWhere[] = []
filters to apply to model records.
Return values
intdelete()
Remove the model data from the database.
public
delete(
)
: bool
Return values
boolexists()
Returns true if the model data is stored in the database.
public
exists(
)
: bool
Return values
boolget()
Returns the model whose primary column corresponds to the value $cod
public
get(
$code :
string
)
: static|bool
Parameters
- $code : string
Return values
static|boolloadFromCode()
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(
$code :
string
[, $where :
array
= [] ]
[, $order :
array
= [] ]
)
: 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 = []
- $order : array = []
Return values
boolnewCode()
Returns the following code for the reported field or the primary key of the model.
public
newCode(
[ $field :
string
= '' ]
[, $where :
array
= [] ]
)
: int
Parameters
- $field : string = ''
- $where : array = []
Return values
intprimaryDescriptionColumn()
Returns the name of the column that describes the model, such as name, description.
public
primaryDescriptionColumn(
)
: string
..
Return values
stringprimaryDescription()
Descriptive identifier for humans of the data record
public
primaryDescription(
)
: string
Return values
stringsave()
Stores the model data in the database.
public
save(
)
: bool
Return values
booltest()
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
boolurl()
Returns the url where to see / modify the data.
public
url(
[ $type :
string
= 'auto' ]
[, $list :
string
= 'List' ]
)
: string
Parameters
- $type : string = 'auto'
- $list : string = 'List'
Return values
stringgetOrderBy()
Convert an array of filters order by in string.
private
getOrderBy(
$order :
array
)
: string
Parameters
- $order : array
Return values
stringgetRecord()
Read the record whose primary column corresponds to the value $cod or the first that meets the indicated condition.
private
getRecord(
$code :
string
[, $where :
array
= [] ]
[, $order :
array
= [] ]
)
: array
Parameters
- $code : string
- $where : array = []
- $order : array = []
Return values
arrayaddExtension()
Adds an extension to this model.
public
abstract static addExtension(
$extension :
mixed
)
: mixed
Parameters
- $extension : mixed
Return values
mixedpipe()
Executes all $name methods added from the extensions.
public
abstract pipe(
$name :
string
, ...$arguments :
array
)
: mixed
Parameters
- $name : string
- $arguments : array
Return values
mixed__construct()
ModelClass constructor.
public
__construct(
[ $data :
array
= [] ]
)
: mixed
Parameters
- $data : array = []
Return values
mixedchangePrimaryColumnValue()
Change the value of the primary column in the model and the database.
public
changePrimaryColumnValue(
$newValue :
mixed
)
: bool
Parameters
- $newValue : mixed
Return values
boolprimaryColumnValue()
Returns the current value of the main column of the model.
public
primaryColumnValue(
)
: mixed
Return values
mixedtoArray()
Returns an array with the model fields values.
public
toArray(
)
: array
Return values
arraycheckTable()
Checks and updates the structure of the table if necessary.
private
checkTable(
)
: bool
Return values
boolgetBoolValueForField()
Returns the boolean value for the field.
private
getBoolValueForField(
$field :
array
, $value :
string
)
: bool|null
Parameters
- $field : array
- $value : string
Return values
bool|nullgetFloatValueForField()
Returns the float value for the field.
private
getFloatValueForField(
$field :
array
, $value :
string
)
: float|null
Parameters
- $field : array
- $value : string
Return values
float|nullgetIntegerValueForField()
Returns the integer value by controlling special cases for the PK and FK.
private
getIntegerValueForField(
$field :
array
, $value :
string
)
: int|null
Parameters
- $field : array
- $value : string
Return values
int|nulltoolBox()
protected
static toolBox(
)
: ToolBox