====== DbInterface ======

**Layer:** ''Core'' · **Source:** ''lib/core/DbInterface.php:20'' (lines 20–111)

----
<code>
interface DbInterface
</code>

Describe the functionality
that any database adapter will need.

======= Docblock Metadata =======

^ Tag ^ Value ^
| ''@category'' | Core Class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

======= Inheritance =======

//No parent, interface or trait. This is a root type.//

======= Constants (0) =======

//None.//

======= Properties (0) =======

//None declared.//

======= Methods (12) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''setDbConnection()'' | Set database connection. | 29 |
| public | ''closeDbConnection()'' | Close database connection. | 34 |
| public | ''dbQuery()'' | Execute an SQL query. | 43 |
| public | ''dbInsert()'' | Insert a new record. | 53 |
| public | ''dbReplace()'' | Insert ... On Duplicate Key Update. | 65 |
| public | ''dbUpdate()'' | Update an existing record. | 75 |
| public | ''dbDelete()'' | Delete a record. | 85 |
| public | ''dbLastInsertId()'' | Get the last inserted ID. | 90 |
| public | ''dbTransaction()'' | Start a transaction. | 95 |
| public | ''dbCommit()'' | Commit the current transaction. | 100 |
| public | ''dbRollBack()'' | Rollback the current transaction. | 105 |
| public | ''isConnected()'' | Check if a database connection is active. | 110 |


======== setDbConnection() ========

<code>
public function setDbConnection(array $config, array $options = []): void
</code>

//line 29//

Set database connection.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$config'' |  ''array'' |  //required// |  //none// |
|  ''$options'' |  ''array'' |  ''[]'' |  //none// |

**Returns:** ''void'' — void


======== closeDbConnection() ========

<code>
public function closeDbConnection(): void
</code>

//line 34//

Close database connection.

//Takes no parameters.//

**Returns:** ''void''


======== dbQuery() ========

<code>
public function dbQuery(string $sql, array $parameters = [])
</code>

//line 43//

Execute an SQL query.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$sql'' |  ''string'' |  //required// |  //none// |
|  ''$parameters'' |  ''array'' |  ''[]'' |  //none// |

**Returns:** ''(none declared)'' — \PDOStatement&#124;false


======== dbInsert() ========

<code>
public function dbInsert(string $tablename, array $params): bool
</code>

//line 53//

Insert a new record.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$tablename'' |  ''string'' |  //required// |  //none// |
|  ''$params'' |  ''array'' |  //required// |  //none// |

**Returns:** ''bool'' — boolean


======== dbReplace() ========

<code>
public function dbReplace(string $tablename, array $params, array $updateParams): bool
</code>

//line 65//

Insert ... On Duplicate Key Update.

Replace statement to Insert or Update row. The correct way to do REPLACE INTO

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$tablename'' |  ''string'' |  //required// |  //none// |
|  ''$params'' |  ''array'' |  //required// |  //none// |
|  ''$updateParams'' |  ''array'' |  //required// |  //none// |

**Returns:** ''bool'' — boolean


======== dbUpdate() ========

<code>
public function dbUpdate(string $tablename, array $params, array $where): int
</code>

//line 75//

Update an existing record.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$tablename'' |  ''string'' |  //required// |  //none// |
|  ''$params'' |  ''array'' |  //required// |  //none// |
|  ''$where'' |  ''array'' |  //required// |  //none// |

**Returns:** ''int'' — int


======== dbDelete() ========

<code>
public function dbDelete(string $tablename, array $where, ?int $limit = null): int
</code>

//line 85//

Delete a record.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$tablename'' |  ''string'' |  //required// |  //none// |
|  ''$where'' |  ''array'' |  //required// |  //none// |
|  ''$limit'' |  ''?int'' |  ''null'' |  default null |

**Returns:** ''int'' — int


======== dbLastInsertId() ========

<code>
public function dbLastInsertId(): string
</code>

//line 90//

Get the last inserted ID.

//Takes no parameters.//

**Returns:** ''string''


======== dbTransaction() ========

<code>
public function dbTransaction(): bool
</code>

//line 95//

Start a transaction.

//Takes no parameters.//

**Returns:** ''bool''


======== dbCommit() ========

<code>
public function dbCommit(): bool
</code>

//line 100//

Commit the current transaction.

//Takes no parameters.//

**Returns:** ''bool''


======== dbRollBack() ========

<code>
public function dbRollBack(): bool
</code>

//line 105//

Rollback the current transaction.

//Takes no parameters.//

**Returns:** ''bool''


======== isConnected() ========

<code>
public function isConnected(): bool
</code>

//line 110//

Check if a database connection is active.

//Takes no parameters.//

**Returns:** ''bool''


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//