API Documentation
Back to top  

DB class

Managing database operations

package Default

 Methods

__clone method

__clone() : void

Exceptions

\Exception Thrown in when __clone is called

Begin transaction

beginTransaction() : void

Commit

commit() : void

Get DB instance corresponding to the DB configuration key

connection(string $dbconfig = 'database') : \Kore\DB
Static
fluent This method is part of a fluent interface and will return the same instance

Parameters

$dbconfig

string

DB configuration key

Returns

\Kore\DBDB instance

Run the select count statement

count(string $query, \Kore\array<mixed> $params = array()) : mixed

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

mixedquery results

Run the delete statement

delete(string $query, \Kore\array<mixed> $params = array()) : integer

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

integernumber of deleted records

Run the query statement

execute(string $query, \Kore\array<mixed> $params = array()) : \PDOStatement

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

\PDOStatement\PDOStatement object

Get the IN clause

getInClause(string $marker, \Kore\array<mixed> $values) : \Kore\array<mixed>
Static

Parameters

$marker

string

parameter marker

$values

\Kore\array<mixed>

value specified in the IN clause

Returns

\Kore\array<mixed>IN clause information array( 'IN (:MARKER_0, :MARKER_1, :MARKER_2)', array( 'MARKER_0' => 'value', 'MARKER_1' => 'value', 'MARKER_2' => 'value' ) )

Get PDO instance

getPdo() : \PDO

Returns

\PDOPDO instance

Run the insert statement

insert(string $query, \Kore\array<mixed> $params = array()) : string

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

stringlast insert ID

Rollback

rollback() : void

Run the select statement

select(string $query, \Kore\array<mixed> $params = array()) : \Kore\array<mixed>

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

\Kore\array<mixed>query results

Run the select statement, get only one record

selectFirst(string $query, \Kore\array<mixed> $params = array()) : \Kore\array<mixed>

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

\Kore\array<mixed>query results

Run in a transaction

transaction(callable $callback) : void

Rollback if an exception is raised in the callback.

Parameters

$callback

callable

callback processing

Exceptions

\Exception

Run the update statement

update(string $query, \Kore\array<mixed> $params = array()) : integer

Parameters

$query

string

SQL query

$params

\Kore\array<mixed>

SQL query parameters

Returns

integernumber of updated records

Access DB

connect(string $dbconfig) : void

Parameters

$dbconfig

string

DB configuration key

Exceptions

\Exception Thrown in when the DB configuration does not exist
\PDOException Thrown when DB access fails

__construct method

__construct(string $dbconfig) : void

Parameters

$dbconfig

string

DB configuration key

Get the data_type from the variable

dataType(mixed $value) : integer

Parameters

$value

mixed

variable

Returns

integerdata_type

Get the debug value from the variable

debugValue(mixed $value) : mixed

Parameters

$value

mixed

variable

Returns

mixeddebug value

 Properties

 

PDO instance

$pdo : \PDO

Default