Engine
extends Brick
in package
Uses
Orm
Description of Engine.
Author: Vítězslav Dvořák info@vitexsoftware.cz
Table of Contents
- $connectionSetup : array<string|int, mixed>
- Default connection setup.
- $createColumn : string|null
- Record create time column.
- $database : string
- Database to connect by default.
- $dbLogin : string|null
- DB Login.
- $dbPass : string|null
- DB password.
- $dbSettings : array<string, string>|string
- Default connection settings.
- $dbType : string
- Type of used database.
- $errorInfo : array<string|int, mixed>
- Poslední Chybová zpráva obdržená od SQL serveru.
- $fluent : Query|null
- Fluent Query.
- $myTable : string
- Default table in SQL (part of identity).
- $pdo : PDO|null
- PDO Driver object.
- $port : string|null
- Database port.
- $server : string|null
- Server Host or IP.
- $errorNumber : int
- Kod SQL chyby.
- $multipleteResult : bool
- Only one rows returned ?
- __construct() : mixed
- Database object.
- __sleep() : array<string|int, string>
- Properties to keep.
- dbreload() : bool
- Reload current record from Database.
- dbsync() : bool
- Insert current data into Database and load actual record data back.
- deleteFromSQL() : bool
- Smaže záznam z SQL.
- fixIterator() : array<string|int, mixed>
- Always return array.
- getAll() : array<string|int, mixed>
- Get All records.
- getColumnsFromSQL() : array<string, string>
- Get database columns values by conditions.
- getDataFromSQL() : array<string|int, mixed>
- Load actual $ItemID SQL data.
- getFluentPDO() : Query
- SQL Builder.
- getMyTable() : string
- Returns the name of the currently used SQL table.
- getPdo() : PDO
- (init &) Get PDO instance.
- getRecordName() : string
- Obtain record name if $this->nameColumn is set.
- howToProcess() : string
- insertToSQL() : null|int
- Insert record to SQL database.
- listingQuery() : Select
- Basic Query to return all.
- loadFromSQL() : array<string|int, mixed>
- Retrieves data from SQL for the current $ItemID and uses it in the object.
- loadIdentifier() : void
- Load record using identifier.
- pdoConnect() : PDO
- Perform connect to database.
- recordExist() : bool
- Prove that record is present in DB.
- recordExists() : int
- Check for argument presence.
- saveToSQL() : int
- Save data array to SQL.
- searchColumns() : mixed
- Search columns for given value.
- setmyTable() : void
- Sets the current working table for SQL.
- setMyTable() : void
- Specify used table by name.
- setProperties() : void
- Set/override object properties.
- setUp() : bool
- SetUp database connections.
- setUpDb() : void
- SetUp Object to be ready for connect.
- takeToData() : null|array<string|int, mixed>
- Assign data from field to data array.
- updateToSQL() : int
- Perform SQL record update.
- useIdentifier() : void
- Use Given value as identifier.
Properties
$connectionSetup
Default connection setup.
public
array<string|int, mixed>
$connectionSetup
= []
$createColumn
Record create time column.
public
string|null
$createColumn
= null
$database
Database to connect by default.
public
string
$database
= ''
$dbLogin
DB Login.
public
string|null
$dbLogin
= null
$dbPass
DB password.
public
string|null
$dbPass
= null
$dbSettings
Default connection settings.
public
array<string, string>|string
$dbSettings
= []
$dbType
Type of used database.
public
string
$dbType
= ''
mysql|pgsql|..
$errorInfo
Poslední Chybová zpráva obdržená od SQL serveru.
public
array<string|int, mixed>
$errorInfo
= []
$fluent
Fluent Query.
public
Query|null
$fluent
$myTable
Default table in SQL (part of identity).
public
string
$myTable
= ''
$pdo
PDO Driver object.
public
PDO|null
$pdo
= null
$port
Database port.
public
string|null
$port
= null
$server
Server Host or IP.
public
string|null
$server
= null
$errorNumber
Kod SQL chyby.
protected
int
$errorNumber
$multipleteResult
Only one rows returned ?
private
bool
$multipleteResult
Methods
__construct()
Database object.
public
__construct([mixed $identifier = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $identifier : mixed = null
- $options : array<string|int, mixed> = []
-
'autoload'=>false prevent initial autoloading, keyColumn,myTable,createColumn,lastModifiedColumn,nameColumn
Return values
mixed —__sleep()
Properties to keep.
public
__sleep() : array<string|int, string>
Return values
array<string|int, string> —dbreload()
Reload current record from Database.
public
dbreload() : bool
Return values
bool —dbsync()
Insert current data into Database and load actual record data back.
public
dbsync([array<string, string|int> $data = [] ]) : bool
Parameters
- $data : array<string, string|int> = []
-
Initial data to save
Return values
bool —Operation success
deleteFromSQL()
Smaže záznam z SQL.
public
deleteFromSQL([array<string|int, mixed>|int $data = null ]) : bool
Parameters
- $data : array<string|int, mixed>|int = null
Return values
bool —fixIterator()
Always return array.
public
static fixIterator(Select $query) : array<string|int, mixed>
Parameters
- $query : Select
Return values
array<string|int, mixed> —getAll()
Get All records.
public
getAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —getColumnsFromSQL()
Get database columns values by conditions.
public
getColumnsFromSQL(array<string|int, string> $columnsList[, array<string, string|int>|int|string $conditions = null ][, array<string|int, mixed>|string $orderBy = null ][, string $indexBy = null ][, int $limit = null ]) : array<string, string>
Parameters
- $columnsList : array<string|int, string>
-
column names listing
- $conditions : array<string, string|int>|int|string = null
-
conditions or ID
- $orderBy : array<string|int, mixed>|string = null
-
sort by
- $indexBy : string = null
-
result keys by row keys
- $limit : int = null
-
maximum number of results
Return values
array<string, string> —getDataFromSQL()
Load actual $ItemID SQL data.
public
getDataFromSQL([int $itemID = null ][, array<string|int, mixed> $columnsList = ['*'] ]) : array<string|int, mixed>
Parameters
- $itemID : int = null
-
record key
- $columnsList : array<string|int, mixed> = ['*']
Return values
array<string|int, mixed> —Results
getFluentPDO()
SQL Builder.
public
getFluentPDO([bool $read = false ][, bool $write = false ]) : Query
Parameters
- $read : bool = false
-
convert mode for select
- $write : bool = false
-
convert mode for insert
Return values
Query —getMyTable()
Returns the name of the currently used SQL table.
public
getMyTable() : string
Return values
string —getPdo()
(init &) Get PDO instance.
public
getPdo([array<string, string> $properties = [] ]) : PDO
Parameters
- $properties : array<string, string> = []
-
$name Connection Properties
Return values
PDO —getRecordName()
Obtain record name if $this->nameColumn is set.
public
getRecordName() : string
Return values
string —howToProcess()
public
howToProcess(Engine $identifier) : string
Parameters
- $identifier : Engine
Return values
string —id|name|values|reuse|unknown
insertToSQL()
Insert record to SQL database.
public
insertToSQL([array<string|int, mixed> $data = null ]) : null|int
Parameters
- $data : array<string|int, mixed> = null
Return values
null|int —id of new row in database
listingQuery()
Basic Query to return all.
public
listingQuery() : Select
Return values
Select —loadFromSQL()
Retrieves data from SQL for the current $ItemID and uses it in the object.
public
loadFromSQL(array<string|int, mixed>|int $itemID) : array<string|int, mixed>
Parameters
- $itemID : array<string|int, mixed>|int
-
Record key
Return values
array<string|int, mixed> —Results
loadIdentifier()
Load record using identifier.
public
loadIdentifier(mixed $identifier) : void
Parameters
- $identifier : mixed
Return values
void —pdoConnect()
Perform connect to database.
public
pdoConnect([mixed $options = [] ]) : PDO
Parameters
- $options : mixed = []
Return values
PDO —SQL connector
recordExist()
Prove that record is present in DB.
public
recordExist([array<string|int, mixed>|int|string $identifier = null ]) : bool
Parameters
- $identifier : array<string|int, mixed>|int|string = null
Return values
bool —Record was found ?
recordExists()
Check for argument presence.
public
recordExists(array<string|int, mixed>|int|string $data) : int
Parameters
- $data : array<string|int, mixed>|int|string
-
int for ID column, use string to search in nameColumn
Return values
int —number of occurrences
saveToSQL()
Save data array to SQL.
public
saveToSQL([array<string, string> $data = null ]) : int
Parameters
- $data : array<string, string> = null
-
asociativní pole dat
Return values
int —ID záznamu nebo null v případě neůspěchu
searchColumns()
Search columns for given value.
public
searchColumns(string $searchTerm, array<string|int, mixed> $columns) : mixed
Parameters
- $searchTerm : string
- $columns : array<string|int, mixed>
Return values
mixed —setmyTable()
Sets the current working table for SQL.
public
setmyTable(string $myTable) : void
Parameters
- $myTable : string
Return values
void —setMyTable()
Specify used table by name.
public
setMyTable(string $tablename) : void
Parameters
- $tablename : string
Return values
void —setProperties()
Set/override object properties.
public
setProperties([array<string, string> $properties = [] ]) : void
Parameters
- $properties : array<string, string> = []
Return values
void —setUp()
SetUp database connections.
public
setUp([array<string, string> $options = [] ]) : bool
Parameters
- $options : array<string, string> = []
Return values
bool —setUpDb()
SetUp Object to be ready for connect.
public
setUpDb([array<string, string> $options = [] ]) : void
Parameters
- $options : array<string, string> = []
-
Object Options (dbType,server,username,password,database, port,connectionSettings,myTable,debug)
Return values
void —takeToData()
Assign data from field to data array.
public
takeToData(array<string|int, mixed> $data, string $column[, bool $mayBeNull = false ][, string $renameAs = null ]) : null|array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
asociativní pole dat
- $column : string
-
název položky k převzetí
- $mayBeNull : bool = false
-
nahrazovat chybejici hodnotu nullem ?
- $renameAs : string = null
-
název cílového políčka
Tags
Return values
null|array<string|int, mixed> —array taken or not
updateToSQL()
Perform SQL record update.
public
updateToSQL([array<string, string> $data = null ][, array<string, string> $conditons = [] ]) : int
Parameters
- $data : array<string, string> = null
-
to save
- $conditons : array<string, string> = []
-
Update condition
Return values
int —Numeber of rows updated
useIdentifier()
Use Given value as identifier.
public
useIdentifier(mixed $identifier) : void
Parameters
- $identifier : mixed