Documentation

Orm

Tags
author

Vítězslav Dvořák info@vitexsoftware.cz

Table of Contents

$connectionSettings  : array<string|int, mixed>
Default connection settings.
$database  : string
Database to connect by default.
$dbType  : string
Type of used database.
$errorInfo  : array<string|int, mixed>
Poslední Chybová zpráva obdržená od SQL serveru.
$errorNumber  : int
Kod SQL chyby.
$fluent  : Fluent
$password  : string
DB heslo.
$pdo  : PDO
PDO Driver object
$port  : string
Database port.
$server  : string
IP serveru.
$username  : string
DB Login.
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.
getColumnsFromSQL()  : array<string|int, mixed>
Vrací z databáze sloupečky podle podmínek.
getDataFromSQL()  : array<string|int, mixed>
Načte z SQL data k aktuálnímu $ItemID.
getFluentPDO()  : FluentPDO
SQL Builder
getMyTable()  : string
We work with table
getPdo()  : PDO
(init &) Get PDO instance
insertToSQL()  : int|null
Insert record to SQL database.
listingQuery()  : FluentPDO
loadFromSQL()  : array<string|int, mixed>
Načte z SQL data k aktuálnímu $ItemID a použije je v objektu.
pdoConnect()  : PDO
Perform connect to database.
saveToSQL()  : int
Uloží pole dat do SQL.
setMyTable()  : mixed
Specify used table by name
setUp()  : mixed
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.

Properties

$connectionSettings

Default connection settings.

public array<string|int, mixed> $connectionSettings = []

$database

Database to connect by default.

public string $database = null

$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 = []

$errorNumber

Kod SQL chyby.

public int $errorNumber = null

$fluent

public Fluent $fluent = null

$password

DB heslo.

public string $password = null

$pdo

PDO Driver object

public PDO $pdo = null

$port

Database port.

public string $port = null

$server

IP serveru.

public string $server = null

$username

DB Login.

public string $username = null

Methods

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|int, mixed> $data = null ]) : bool
Parameters
$data : array<string|int, mixed> = null

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

getColumnsFromSQL()

Vrací z databáze sloupečky podle podmínek.

public getColumnsFromSQL(array<string|int, mixed> $columnsList[, array<string|int, mixed>|int|string $conditions = null ][, array<string|int, mixed>|string $orderBy = null ][, string $indexBy = null ][, int $limit = null ]) : array<string|int, mixed>
Parameters
$columnsList : array<string|int, mixed>

seznam položek

$conditions : array<string|int, mixed>|int|string = null

pole podmínek nebo ID záznamu

$orderBy : array<string|int, mixed>|string = null

třídit dle

$indexBy : string = null

klice vysledku naplnit hodnotou ze sloupečku

$limit : int = null

maximální počet vrácených záznamů

Return values
array<string|int, mixed>

getDataFromSQL()

Načte z SQL data k aktuálnímu $ItemID.

public getDataFromSQL([int $itemID = null ]) : array<string|int, mixed>
Parameters
$itemID : int = null

klíč záznamu

Return values
array<string|int, mixed>

Results

getFluentPDO()

SQL Builder

public getFluentPDO([bool $read = false ][, bool $write = false ]) : FluentPDO
Parameters
$read : bool = false

convert mode for select

$write : bool = false

convert mode for insert

Return values
FluentPDO

getMyTable()

We work with table

public getMyTable() : string
Return values
string

getPdo()

(init &) Get PDO instance

public getPdo([mixed $propeties = [] ]) : PDO
Parameters
$propeties : mixed = []
Return values
PDO

insertToSQL()

Insert record to SQL database.

public insertToSQL([array<string|int, mixed> $data = null ]) : int|null
Parameters
$data : array<string|int, mixed> = null
Return values
int|null

id of new row in database

listingQuery()

public listingQuery() : FluentPDO
Return values
FluentPDO

loadFromSQL()

Načte z SQL data k aktuálnímu $ItemID a použije je v objektu.

public loadFromSQL(int|array<string|int, mixed> $itemID) : array<string|int, mixed>
Parameters
$itemID : int|array<string|int, mixed>

klíč záznamu

Return values
array<string|int, mixed>

Results

pdoConnect()

Perform connect to database.

public pdoConnect([mixed $options = [] ]) : PDO
Parameters
$options : mixed = []
Return values
PDO

SQL connector

saveToSQL()

Uloží pole dat do SQL.

public saveToSQL([array<string|int, mixed> $data = null ]) : int
Parameters
$data : array<string|int, mixed> = null

asociativní pole dat

Return values
int

ID záznamu nebo null v případě neůspěchu

setMyTable()

Specify used table by name

public setMyTable(string $tablename) : mixed
Parameters
$tablename : string
Return values
mixed

setUp()

SetUp Object to be ready for connect

public setUp([array<string|int, mixed> $options = [] ]) : mixed
Parameters
$options : array<string|int, mixed> = []

Object Options (dbType,server,username,password,database, port,connectionSettings,myTable,debug)

Return values
mixed

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
deprecated

since version 0.1

Return values
null|array<string|int, mixed>

array taken or not

updateToSQL()

Perform SQL record update.

public updateToSQL([array<string|int, mixed> $data = null ][, array<string|int, mixed> $conditons = [] ]) : int

Provede update záznamu do SQL.

Parameters
$data : array<string|int, mixed> = null

to save

$conditons : array<string|int, mixed> = []

Update condition

Return values
int

Id záznamu nebo null v případě chyby

Search results