Adapter

About 3 min

Adapter

Relational Database Interface

The DB Adapter module provides classes for access to relational database via PDO (PHP Data Object) drivers and classes. This approach allows developers to use these classes to access a range of different database servers.

PDO has supporting drivers for:

Access to database functions is all implemented using a common class structure. This allows developers to create database queries in code without consideration for the underlying SQL. SQL is generated "under the hood" using a database specific driver that will automatically take care of any differences in the database servers SQL implementation.

Example Usage

$db = Hazaar\DBI\Adapter::getInstance();

$result = $this->execute('SELECT * FROM users');

while($row = $result->fetch()){

//Do things with $row here

}

Properties

defaultConfig

public array $defaultConfig

config

public Map $config

driver

public BaseDriver $driver

loadedConfigs

private array $loadedConfigs

schemaManager

public Manager $schemaManager

connections

private array $connections

instances

private array $instances

managerInstances

private array $managerInstances

statements

private array $statements

dsn

public string $dsn

Methods

__construct

Hazaar DBI Constructor.

public  __construct({Array})

Parameters

Parameter	Type	Description
`$config`	`string`	An array of configuration options to instantiate the DBI Adapter. This can

                                   also be a Hazaar MVC configuration environment if DBI is being used by an HMVC
                                   application. |

__call

public  __call({Array})

Parameters

Parameter	Type	Description
`$method`	`string`
`$args`	`array`

getInstance

public  getInstance({Array})

Parameters

Parameter	Type	Description
`$configEnv`	`string`

getSchemaManagerInstance

public  getSchemaManagerInstance({Array})

Parameters

Parameter	Type	Description
`$configEnv`	`string`
`$logCallback`	`callable`

getDriverClass

public  getDriverClass({Array})

Parameters

Parameter	Type	Description
`$driver`	`string`

setDefaultConfig

public  setDefaultConfig({Array})

Parameters

Parameter	Type	Description
`$config`	`string`
`$env`	`string`

getDefaultConfig

public  getDefaultConfig({Array})

Parameters

Parameter	Type	Description
`$configName`	`string`

connect

public  connect({Array})

Parameters

Parameter	Type	Description
`$dsn`	`string`
`$username`	`string`
`$password`	`string`
`$driverOptions`	`array`
`$reconnect`	`bool`

getDriver

public  getDriver({Array})

getAvailableDrivers

public  getAvailableDrivers({Array})

subquery

Build a sub-query using an existing query.

public  subquery({Array})

Parameters

Parameter	Type	Description
`$subquery`	`Table`	Table The existing query to use as the sub-query
`$name`	`string`	The named alias of the sub-query

query

public  query({Array})

Parameters

Parameter	Type	Description
`$sql`	`string`

exists

public  exists({Array})

Parameters

Parameter	Type	Description
`$table`	`string`
`$criteria`	`mixed`

table

public  table({Array})

Parameters

Parameter	Type	Description
`$name`	`string`
`$alias`	`string`

from

public  from({Array})

Parameters

Parameter	Type	Description
`$name`	`string`
`$alias`	`string`

call

public  call({Array})

Parameters

Parameter	Type	Description
`$method`	`string`
`$args`	`array`
`$criteria`	`mixed`

prepare

Prepared statements.

public  prepare({Array})

Parameters

Parameter	Type	Description
`$sql`	`string`
`$name`	`string`

execute

public  execute({Array})

Parameters

Parameter	Type	Description
`$name`	`string`
`$inputParameters`	`array`

getPreparedStatements

public  getPreparedStatements({Array})

listPreparedStatements

public  listPreparedStatements({Array})

getSchemaManager

Returns an instance of the Hazaar\DBI\Schema\Manager for managing database schema versions.

public  getSchemaManager({Array})

insert

Perform and "upsert".

public  insert({Array})

An upsert is an INSERT, that when it fails, columns can be updated in the existing row.

Parameters

Parameter	Type	Description
`$tableName`	`string`	the table to insert a record into
`$fields`	`mixed`	the fields to be inserted
`$returning`	`mixed`	a column to return when the row is inserted (usually the primary key)
`$conflictTarget`	`string`	the column(s) to check for a conflict. If the conflict is found,

                                            the row will be updated. |

| $conflictUpdate | array | | | $table | Table | | | $ | int | |

update

public  update({Array})

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$fields`	`mixed`
`$criteria`	`mixed`
`$from`	`array`
`$returning`	`mixed`
`$tables`	`array`
`$`	`int`

encrypt

public  encrypt({Array})

Parameters

Parameter	Type	Description
`$table`	`string`
`$data`	`mixed`

errorException

public  errorException({Array})

Parameters

Parameter	Type	Description
`$msg`	`string`

parseSQL

Parse an SQL query into a DBI Table query so that it can be manipulated.

public  parseSQL({Array})

Parameters

Parameter	Type	Description
`$sql`	`string`	The SQL query to parse

grant

Grant privileges on a table to a user.

public  grant({Array})

Parameters

Parameter	Type	Description
`$table`	`string`	the name of the table to grant privileges on
`$user`	`string`	The name of the user who is being given the privileges
`$privileges`	`string`	One or more privileges being applied. Example: (string)'ALL' and (array)['INSERT', 'UPDATE', 'DELETE'] are both valid.

reconfigure

private  reconfigure({Array})

Parameters

Parameter	Type	Description
`$reconnect`	`bool`

Generated by Hazaar API Doc Generator