FacturaScripts

Empresa extends Contact Uses ModelTrait

This class stores the main data of the company.

Table of Contents

$administrador Name of the company administrator. string
$apartado Post office box of the address. string
$ciudad City of the address. string
$codpais Country of the address. string
$codpostal Postal code of the address. string
$direccion Address. string
$idempresa Primary key. Integer. int
$idlogo int
$nombrecorto Short name of the company, to show on the menu. string
$provincia Province of the address. string
$regimeniva Taxation regime of the provider. For now they are only implemented general and exempt. string
$web Website of the person. string
$fields List of fields in the table. array
$cifnif Tax identifier of the customer. string
$email Email of the person. string
$fax Fax of the person. string
$fechaalta Date on which the customer was registered. string
$nombre Name by which we know the contact, not necessarily the official. string
$observaciones Observations of the person. string
$personafisica True -> the customer is a natural person. bool
$telefono1 Phone 1 of the person. string
$telefono2 Phone 2 of the person. string
$tipoidfiscal Type of tax identification of the client. 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() Removes company from database. bool
getBankAccounts() Returns the bank accounts associated with the company. \FacturaScripts\Dinamic\Model\CuentaBanco[]
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
isDefault() Returns True if this is the default company. bool
primaryColumn() Returns the name of the column that is the model's primary key. string
primaryDescriptionColumn() Returns the description of the column that is the model's primary key. string
tableName() Returns the name of the table that uses this model. string
test() Check the company's data, return TRUE if correct bool
createPaymentMethods() mixed
createWarehouse() mixed
saveInsert() 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
clear() Reset the values of all model properties. mixed
gravatar() Returns gravatar image url. string
test() Returns true if there are no errors in the values of the model properties. 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
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
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
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
getIntergerValueForField() Returns the integer value by controlling special cases for the PK and FK. int|null
toolBox() ToolBox

Properties

$administrador

Name of the company administrator.

public string $administrador

$apartado

Post office box of the address.

public string $apartado

$ciudad

City of the address.

public string $ciudad

$codpais

Country of the address.

public string $codpais

$codpostal

Postal code of the address.

public string $codpostal

$direccion

Address.

public string $direccion

$idempresa

Primary key. Integer.

public int $idempresa

$nombrecorto

Short name of the company, to show on the menu.

public string $nombrecorto

$provincia

Province of the address.

public string $provincia

$regimeniva

Taxation regime of the provider. For now they are only implemented general and exempt.

public string $regimeniva

$web

Website of the person.

public string $web

$fields

List of fields in the table.

protected static array $fields = []

$cifnif

Tax identifier of the customer.

public string $cifnif

$email

Email of the person.

public string $email

$fax

Fax of the person.

public string $fax

$fechaalta

Date on which the customer was registered.

public string $fechaalta

$nombre

Name by which we know the contact, not necessarily the official.

public string $nombre

$observaciones

Observations of the person.

public string $observaciones

$personafisica

True -> the customer is a natural person.

public bool $personafisica
False -> the client is a legal person (company).

$telefono1

Phone 1 of the person.

public string $telefono1

$telefono2

Phone 2 of the person.

public string $telefono2

$tipoidfiscal

Type of tax identification of the client.

public string $tipoidfiscal
Examples: CIF, NIF, CUIT ...

$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()

Removes company from database.

public delete( ) : bool
Return values
bool

getBankAccounts()

Returns the bank accounts associated with the company.

public getBankAccounts( ) : \FacturaScripts\Dinamic\Model\CuentaBanco[]
Return values
\FacturaScripts\Dinamic\Model\CuentaBanco[]

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

isDefault()

Returns True if this is the default company.

public isDefault( ) : bool
Return values
bool

primaryColumn()

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

public static primaryColumn( ) : string
Return values
string

primaryDescriptionColumn()

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

public primaryDescriptionColumn( ) : string
Return values
string

tableName()

Returns the name of the table that uses this model.

public static tableName( ) : string
Return values
string

test()

Check the company's data, return TRUE if correct

public test( ) : bool

It runs inside the save method.

Return values
bool

createPaymentMethods()

protected createPaymentMethods( ) : mixed
Return values
mixed

createWarehouse()

protected createWarehouse( ) : mixed
Return values
mixed

saveInsert()

protected saveInsert( [ $values : array = [] ] ) : bool
Parameters
$values : array = []
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

clear()

Reset the values of all model properties.

public clear( ) : mixed
Return values
mixed

gravatar()

Returns gravatar image url.

public gravatar( [ $size : int = 80 ] ) : string
Parameters
$size : int = 80
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

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

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

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

primaryColumnValue()

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

public primaryColumnValue( ) : mixed
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