Adapter

About 7 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 = array (
  'encrypt' => 
  array (
    'cipher' => 'aes-256-ctr',
    'checkstring' => '!!',
  ),
)

config

public array $config

instances

private array $instances

loadedConfigs

private array $loadedConfigs

public  $

schemaManager

private Manager $schemaManager

managerInstances

private array $managerInstances

env

private string $env = 'APPLICATION_ENV'

eventLog

private array $eventLog

public  $

Methods

__construct

Hazaar DBI Constructor.

public __construct(string $config): void

Parameters

Parameter	Type	Description
`$config`	`string`	An array of configuration options to instantiate the DBI Adapter. This can also be a Hazaar configuration environment if DBI is being used by a Hazaar application.

__call

Magic method to pass any undefined methods to the driver.

public __call(string $method, array $args): mixed

This allows the DBI Adapter to be used as a proxy to the underlying driver.

Parameters

Parameter	Type	Description
`$method`	`string`	The method name to call
`$args`	`array`	The arguments to pass to the method

registerLogHandler

Sets a callback function that can be used to process log messages as they are generated.

public registerLogHandler(\Closure $callback): void

The callback function provided must accept one argument. LogEvent $event.

Example, to simply echo formatted log data:

'''php $manager->registerLogHandler(function(LogEvent $event){ echo $event->toString() . PHP_EOL; }); '''

Parameters

Parameter	Type	Description
`$callback`	`\Closure`	The 'callable' callback function. See: is_callable();

can

public can(string $method): bool

Parameters

Parameter	Type	Description
`$method`	`string`

getDriverName

public getDriverName(): string

getSchemaManager

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

public getSchemaManager(?\Closure $logCallback): Manager

Parameters

Parameter	Type	Description
`$logCallback`	`\Closure`

getInstance

Return an existing or create a new instance of a DBI Adapter.

public getInstance(?string $configEnv = 'APPLICATION_ENV'): self

This function should be the main entrypoint to the DBI Adapter class as it implements instance tracking to reduce the number of individual connections to a database. Normally, instantiating a new DBI Adapter will create a new connection to the database, even if one already exists. This may be desired so this functionality still exists.

However, if using Hazaar\DBI\Adapter::getInstance() you will be returned an existing instance if one exists allowing a single connection to be used from multiple sections of code, without the need to pass around an existing reference.

NOTE: Only the first instance created is tracked, so it is still possible to create multiple connections by instantiating the DBI Adapter directly. The choice is yours.

Parameters

Parameter	Type	Description
`$configEnv`	`string`

getSchemaManagerInstance

Return an existing or create a new instance of a DBI Schema Manager;.

public getSchemaManagerInstance(?string $configEnv, ?callable $logCallback): Manager

Parameters

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

errorException

public errorException(?string $msg): void

Parameters

Parameter	Type	Description
`$msg`	`string`

insert

Insert a new record into the specified table.

public insert(string $tableName, mixed $data, mixed $returning): mixed

Parameters

Parameter	Type	Description
`$tableName`	`string`	the name of the table to insert the record into
`$data`	`mixed`	The data to be inserted. This can be an associative array or an object.
`$returning`	`mixed`	Optional. Whether to return the inserted record. Defaults to false.

update

Update a record in the specified table.

public update(string $tableName, mixed $data, mixed $where, mixed $returning): int

Parameters

Parameter	Type	Description
`$tableName`	`string`	the name of the table to update the record in
`$data`	`mixed`	The data to be updated. This can be an associative array or an object.
`$where`	`mixed`	The WHERE clause to apply to the update. This can be an associative array or an object.
`$returning`	`mixed`	Optional. Whether to return the updated record. Defaults to false.

delete

Delete a record from the specified table.

public delete(string $tableName, mixed $where): int

Parameters

Parameter	Type	Description
`$tableName`	`string`	the name of the table to delete the record from
`$where`	`mixed`	The WHERE clause to apply to the delete. This can be an associative array or an object.

table

Returns a Table object for the specified table name.

public table(string $tableName, ?string $alias): Table

Parameters

Parameter	Type	Description
`$tableName`	`string`	the name of the table
`$alias`	`string`

loadConfig

Returns a Query object for the specified table name.

public loadConfig(?string $configName): Config

Parameters

Parameter	Type	Description
`$configName`	`string`

listConstraints

public listConstraints(NULL $table, NULL $type, boolean $invertType, false $): void

Parameters

Parameter	Type	Description
`$table`	`NULL`
`$type`	`NULL`
`$invertType`	`boolean`
`$`	`false`

addConstraint

public addConstraint(string $constraintName, array $info): bool

Parameters

Parameter	Type	Description
`$constraintName`	`string`
`$info`	`array`

dropConstraint

public dropConstraint(string $constraintName, string $tableName, bool $ifExists, bool $cascade): bool

Parameters

Parameter	Type	Description
`$constraintName`	`string`
`$tableName`	`string`
`$ifExists`	`bool`
`$cascade`	`bool`

listExtensions

public listExtensions(): void

extensionExists

public extensionExists(string $name): bool

Parameters

Parameter	Type	Description
`$name`	`string`

createExtension

public createExtension(string $name): bool

Parameters

Parameter	Type	Description
`$name`	`string`

dropExtension

public dropExtension(string $name, bool $ifExists): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$ifExists`	`bool`

listGroups

public listGroups(): void

createGroup

public createGroup(string $groupName): bool

Parameters

Parameter	Type	Description
`$groupName`	`string`

dropGroup

public dropGroup(string $groupName): bool

Parameters

Parameter	Type	Description
`$groupName`	`string`

addToGroup

public addToGroup(string $roleName, string $parentRoleName): bool

Parameters

Parameter	Type	Description
`$roleName`	`string`
`$parentRoleName`	`string`

removeFromGroup

public removeFromGroup(string $roleName, string $parentRoleName): bool

Parameters

Parameter	Type	Description
`$roleName`	`string`
`$parentRoleName`	`string`

listIndexes

public listIndexes(?string $tableName): void

Parameters

Parameter	Type	Description
`$tableName`	`string`

indexExists

public indexExists(string $indexName, ?string $tableName): bool

Parameters

Parameter	Type	Description
`$indexName`	`string`
`$tableName`	`string`

createIndex

public createIndex(string $indexName, string $tableName, mixed $idxInfo): bool

Parameters

Parameter	Type	Description
`$indexName`	`string`
`$tableName`	`string`
`$idxInfo`	`mixed`

dropIndex

public dropIndex(string $indexName, bool $ifExists): bool

Parameters

Parameter	Type	Description
`$indexName`	`string`
`$ifExists`	`bool`

getSchemaName

public getSchemaName(): string

schemaExists

public schemaExists(?string $schemaName): bool

Parameters

Parameter	Type	Description
`$schemaName`	`string`

createSchema

public createSchema(?string $schemaName): bool

Parameters

Parameter	Type	Description
`$schemaName`	`string`

listSequences

public listSequences(): void

sequenceExists

public sequenceExists(string $sequenceName): bool

Parameters

Parameter	Type	Description
`$sequenceName`	`string`

describeSequence

public describeSequence(string $name, false $): void

Parameters

Parameter	Type	Description
`$name`	`string`
`$`	`false`

createSequence

public createSequence(string $name, array $sequenceInfo, bool $ifNotExists): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$sequenceInfo`	`array`
`$ifNotExists`	`bool`

dropSequence

public dropSequence(string $name, bool $ifExists): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$ifExists`	`bool`

nextSequenceValue

public nextSequenceValue(string $name): int

Parameters

Parameter	Type	Description
`$name`	`string`

setSequenceValue

public setSequenceValue(string $name, int $value): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$value`	`int`

createDatabase

public createDatabase(string $name): bool

Parameters

Parameter	Type	Description
`$name`	`string`

exec

public exec(string $sql): int

Parameters

Parameter	Type	Description
`$sql`	`string`

query

public query(string $sql): Result

Parameters

Parameter	Type	Description
`$sql`	`string`

quote

public quote(mixed $string, int $type = '\PDO::PARAM_STR'): string

Parameters

Parameter	Type	Description
`$string`	`mixed`
`$type`	`int`

setTimezone

public setTimezone(string $tz): bool

Parameters

Parameter	Type	Description
`$tz`	`string`

errorInfo

public errorInfo(false $): void

Parameters

Parameter	Type	Description
`$`	`false`

errorCode

public errorCode(): string

getQueryBuilder

public getQueryBuilder(): QueryBuilderInterface

repair

public repair(): bool

lastQueryString

public lastQueryString(): string

listFunctions

public listFunctions(bool $includeParameters): void

Parameters

Parameter	Type	Description
`$includeParameters`	`bool`

functionExists

public functionExists(string $functionName, ?string $argTypes): bool

Parameters

Parameter	Type	Description
`$functionName`	`string`
`$argTypes`	`string`

describeFunction

public describeFunction(string $name, false $): void

Parameters

Parameter	Type	Description
`$name`	`string`
`$`	`false`

createFunction

public createFunction(string $name, mixed $spec, bool $replace): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$spec`	`mixed`
`$replace`	`bool`

dropFunction

public dropFunction(string $name, string $argTypes, bool $cascade, bool $ifExists): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$argTypes`	`string`
`$cascade`	`bool`
`$ifExists`	`bool`

listTables

public listTables(): void

tableExists

public tableExists(string $tableName): bool

Parameters

Parameter	Type	Description
`$tableName`	`string`

createTable

public createTable(string $tableName, mixed $columns): bool

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$columns`	`mixed`

describeTable

public describeTable(string $tableName, ?string $sort, false $): void

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$sort`	`string`
`$`	`false`

renameTable

public renameTable(string $fromName, string $toName): bool

Parameters

Parameter	Type	Description
`$fromName`	`string`
`$toName`	`string`

dropTable

public dropTable(string $name, bool $ifExists, bool $cascade): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$ifExists`	`bool`
`$cascade`	`bool`

addColumn

public addColumn(string $tableName, mixed $columnSpec): bool

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$columnSpec`	`mixed`

alterColumn

public alterColumn(string $tableName, string $column, mixed $columnSpec): bool

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$column`	`string`
`$columnSpec`	`mixed`

dropColumn

public dropColumn(string $tableName, string $column, bool $ifExists): bool

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$column`	`string`
`$ifExists`	`bool`

truncate

public truncate(string $tableName, bool $only, bool $restartIdentity, bool $cascade): bool

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$only`	`bool`
`$restartIdentity`	`bool`
`$cascade`	`bool`

begin

public begin(): bool

commit

public commit(): bool

cancel

public cancel(): bool

listTriggers

public listTriggers(?string $tableName): void

Parameters

Parameter	Type	Description
`$tableName`	`string`

triggerExists

public triggerExists(string $triggerName, string $tableName): bool

Parameters

Parameter	Type	Description
`$triggerName`	`string`
`$tableName`	`string`

describeTrigger

public describeTrigger(string $triggerName, false $): void

Parameters

Parameter	Type	Description
`$triggerName`	`string`
`$`	`false`

createTrigger

public createTrigger(string $triggerName, string $tableName, mixed $spec): bool

Parameters

Parameter	Type	Description
`$triggerName`	`string`
`$tableName`	`string`
`$spec`	`mixed`

dropTrigger

public dropTrigger(string $triggerName, string $tableName, bool $ifExists, bool $cascade): bool

Parameters

Parameter	Type	Description
`$triggerName`	`string`
`$tableName`	`string`
`$ifExists`	`bool`
`$cascade`	`bool`

listUsers

public listUsers(): void

createUser

public createUser(string $name, ?string $password, array $privileges): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$password`	`string`
`$privileges`	`array`

dropUser

public dropUser(string $name, bool $ifExists): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$ifExists`	`bool`

grant

public grant(string $role, string $to, string $on): bool

Parameters

Parameter	Type	Description
`$role`	`string`
`$to`	`string`
`$on`	`string`

revoke

public revoke(string $role, string $from, string $on): bool

Parameters

Parameter	Type	Description
`$role`	`string`
`$from`	`string`
`$on`	`string`

listViews

public listViews(): void

viewExists

public viewExists(string $viewName): bool

Parameters

Parameter	Type	Description
`$viewName`	`string`

describeView

public describeView(string $name, false $): void

Parameters

Parameter	Type	Description
`$name`	`string`
`$`	`false`

createView

public createView(string $name, mixed $content, bool $replace): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$content`	`mixed`
`$replace`	`bool`

dropView

public dropView(string $name, bool $ifExists, bool $cascade): bool

Parameters

Parameter	Type	Description
`$name`	`string`
`$ifExists`	`bool`
`$cascade`	`bool`

prepareQuery

public prepareQuery(QueryBuilderInterface $queryBuilder): Statement

Parameters

Parameter	Type	Description
`$queryBuilder`	`QueryBuilderInterface`

prepare

public prepare(string $sql): Statement

Parameters

Parameter	Type	Description
`$sql`	`string`

log

Logs a message to the migration log.

public log(string $msg): void

Parameters

Parameter	Type	Description
`$msg`	`string`	The message to log

getEventLog

Returns the adapter event log.

public getEventLog(): void

getDriverClass

private getDriverClass(string $driver): string

Parameters

Parameter	Type	Description
`$driver`	`string`

reconfigure

private reconfigure(bool $reconnect): bool

Parameters

Parameter	Type	Description
`$reconnect`	`bool`

Generated by Hazaar API Doc Generator