FacturaScripts

User extends ModelClass Uses ModelTrait, CompanyRelationTrait, PasswordTrait

Usuario de FacturaScripts.

Table of Contents

DEFAULT_LEVEL 2
$admin true -> user is admin. bool
$codagente string
$codalmacen string
$creationdate string
$email user's email. string
$enabled true -> user enabled. bool
$homepage Homepage. string
$langcode Language code. string
$lastactivity Last activity date. string
$lastip Last IP used. string
$level Indicates the level of security that the user can access. int
$logkey Session key, saved also in cookie. Regenerated when user log in. string
$nick Primary key. Varchar (50). string
$fields List of fields in the table. array
$idempresa int
$newPassword New password. string
$newPassword2 Repeated new password. string
$password Password hashed with password_hash() string
$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
delete() Remove the model data from the database. 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. string
newLogkey() Generates a new login key for the user. It also updates lastactivity and last IP. string
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
test() Returns True if there is no errors on properties values. bool
updateActivity() Updates last ip address and last activity property. mixed
verifyLogkey() Verifies the login key. bool
saveInsert() Insert the model data in the database. bool
setNewRole() Assigns the first role to this user. mixed
testAgent() bool
testWarehouse() 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
getCompany() Empresa
primaryColumnValue() Returns the current value of the main column of the model. mixed
toolBox() ToolBox
setPassword() Asigns the new password to the user. mixed
verifyPassword() Verifies password. It also rehash the password if needed. bool
testPassword() bool
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
saveInsert() Insert the model data in the database. bool
saveUpdate() Update the model data in the database. bool
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
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
__construct() ModelClass constructor. mixed
changePrimaryColumnValue() Change the value of the primary column in the model and the database. bool
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
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
getIntergerValueForField() Returns the integer value by controlling special cases for the PK and FK. int|null

Constants

DEFAULT_LEVEL

mixed $DEFAULT_LEVEL = 2

DATETIME_STYLE

mixed $DATETIME_STYLE = 'd-m-Y H:i:s'

Properties

$admin

true -> user is admin.

public bool $admin

$codagente

public string $codagente

$codalmacen

public string $codalmacen

$creationdate

public string $creationdate

$email

user's email.

public string $email

$enabled

true -> user enabled.

public bool $enabled

$homepage

Homepage.

public string $homepage

$langcode

Language code.

public string $langcode

$lastactivity

Last activity date.

public string $lastactivity

$lastip

Last IP used.

public string $lastip

$level

Indicates the level of security that the user can access.

public int $level

$logkey

Session key, saved also in cookie. Regenerated when user log in.

public string $logkey

$nick

Primary key. Varchar (50).

public string $nick

$fields

List of fields in the table.

protected static array $fields = []

$newPassword2

Repeated new password.

public string $newPassword2

$password

Password hashed with password_hash()

public string $password

$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
mixed

delete()

Remove the model data from the database.

public delete( ) : bool
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

newLogkey()

Generates a new login key for the user. It also updates lastactivity and last IP.

public newLogkey( $ipAddress : string ) : string
Parameters
$ipAddress : string
Return values
string

primaryColumn()

Returns the name of the column that is the model's primary key.

public static primaryColumn( ) : string
Return values
string

tableName()

Returns the name of the table that uses this model.

public static tableName( ) : string
Return values
string

test()

Returns True if there is no errors on properties values.

public test( ) : bool

It runs inside the save method.

Return values
bool

updateActivity()

Updates last ip address and last activity property.

public updateActivity( $ipAddress : string ) : mixed
Parameters
$ipAddress : string
Return values
mixed

verifyLogkey()

Verifies the login key.

public verifyLogkey( $value : string ) : bool
Parameters
$value : string
Return values
bool

saveInsert()

Insert the model data in the database.

protected saveInsert( [ $values : array = [] ] ) : bool
Parameters
$values : array = []
Return values
bool

setNewRole()

Assigns the first role to this user.

protected setNewRole( ) : mixed
Return values
mixed

testAgent()

protected testAgent( ) : bool
Return values
bool

testWarehouse()

protected testWarehouse( ) : bool
Return values
bool

getModelFields()

Returns the list of fields in the table.

public abstract getModelFields( ) : array
Return values
array

modelClassName()

Returns the name of the class of the model.

public abstract modelClassName( ) : string
Return values
string

modelName()

Returns the name of the model.

protected abstract modelName( ) : string
Return values
string

loadModelFields()

Loads table fields if is necessary.

protected abstract loadModelFields( &$dataBase : DataBase , $tableName : string ) : mixed
Parameters
$dataBase : DataBase
$tableName : string
Return values
mixed

primaryColumnValue()

Returns the current value of the main column of the model.

public primaryColumnValue( ) : mixed
Return values
mixed

setPassword()

Asigns the new password to the user.

public setPassword( $value : string ) : mixed
Parameters
$value : string
Return values
mixed

verifyPassword()

Verifies password. It also rehash the password if needed.

public verifyPassword( $value : string ) : bool
Parameters
$value : string
Return values
bool

testPassword()

protected testPassword( ) : bool
Return values
bool

all()

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
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( $code : string ) : static|bool
Parameters
$code : string
Return values
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.

public loadFromCode( $code : string [, $where : array = [] ] [, $orderby : 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 = []
$orderby : array = []
Return values
bool

newCode()

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
int

primaryDescriptionColumn()

Returns the name of the column that describes the model, such as name, description.

public primaryDescriptionColumn( ) : string

..

Return values
string

primaryDescription()

Descriptive identifier for humans of the data record

public primaryDescription( ) : string
Return values
string

save()

Stores the model data in the database.

public save( ) : bool
Return values
bool

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

url()

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
string

saveInsert()

Insert the model data in the database.

protected saveInsert( [ $values : array = [] ] ) : bool
Parameters
$values : array = []
Return values
bool

saveUpdate()

Update the model data in the database.

protected saveUpdate( [ $values : array = [] ] ) : bool
Parameters
$values : array = []
Return values
bool

getOrderBy()

Convert an array of filters order by in string.

private getOrderBy( $order : array ) : string
Parameters
$order : array
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( $code : string [, $where : array = [] ] [, $orderby : array = [] ] ) : array
Parameters
$code : string
$where : array = []
$orderby : array = []
Return values
array

addExtension()

Adds an extension to this model.

public abstract static addExtension( $extension : mixed ) : mixed
Parameters
$extension : mixed
Return values
mixed

pipe()

Executes all $name methods added from the extensions.

public abstract pipe( $name : string , ...$arguments : array ) : mixed
Parameters
$name : string
$arguments : array
Return values
mixed

primaryColumn()

Returns the name of the column that is the model's primary key.

public abstract static primaryColumn( ) : string
Return values
string

tableName()

Returns the name of the table that uses this model.

public abstract static tableName( ) : string
Return values
string

__construct()

ModelClass constructor.

public __construct( [ $data : array = [] ] ) : mixed
Parameters
$data : array = []
Return values
mixed

changePrimaryColumnValue()

Change the value of the primary column in the model and the database.

public changePrimaryColumnValue( $newValue : mixed ) : bool
Parameters
$newValue : mixed
Return values
bool

clear()

Reset the values of all model properties.

public clear( ) : mixed
Return values
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.

public install( ) : string
Return values
string

loadFromData()

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
mixed

toArray()

Returns an array with the model fields values.

public toArray( ) : array
Return values
array

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( $field : array , $value : string ) : bool|null
Parameters
$field : array
$value : string
Return values
bool|null

getFloatValueForField()

Returns the float value for the field.

private getFloatValueForField( $field : array , $value : string ) : float|null
Parameters
$field : array
$value : string
Return values
float|null

getIntergerValueForField()

Returns the integer value by controlling special cases for the PK and FK.

private getIntergerValueForField( $field : array , $value : string ) : int|null
Parameters
$field : array
$value : string
Return values
int|null

Search results