Documentation

DriverBase
in package
implements LoggerAwareInterface

AbstractYes

Table of Contents

Interfaces

LoggerAwareInterface

Constants

DEFAULT_OPTIONS  = ['return_single_record' => false]

Properties

$logger  : LoggerInterface
$options  : array<string|int, mixed>
$queryOptions  : null|array<string|int, mixed>

Methods

__construct()  : mixed
addConnection()  : void
changeConnection()  : void
dispatch()  : mixed
setLogger()  : void
setOptions()  : void
processRecords()  : mixed
setQueryOptions()  : void
formatRecords()  : mixed
parseOptions()  : array<string|int, mixed>
processOptions()  : array<string|int, mixed>|object

Constants

DEFAULT_OPTIONS

protected mixed DEFAULT_OPTIONS = ['return_single_record' => false]

Properties

$options

private array<string|int, mixed> $options = []

$queryOptions

private null|array<string|int, mixed> $queryOptions = null

Methods

__construct()

public __construct([LoggerInterface $logger = new NullLogger() ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$logger : LoggerInterface = new NullLogger()
$options : array<string|int, mixed> = []

changeConnection()

public abstract changeConnection(int|string $name) : void
Parameters
$name : int|string

dispatch()

public abstract dispatch(Action $action, mixed $args) : mixed
Parameters
$action : Action
$args : mixed

setLogger()

public setLogger(LoggerInterface $logger) : void
Parameters
$logger : LoggerInterface

setOptions()

public setOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>

processRecords()

protected processRecords(array<string|int, mixed> $records, array<string|int, mixed> $formatting) : mixed
Parameters
$records : array<string|int, mixed>
$formatting : array<string|int, mixed>

setQueryOptions()

protected setQueryOptions(null|array<string|int, mixed> $queryOptions) : void
Parameters
$queryOptions : null|array<string|int, mixed>

formatRecords()

private formatRecords(array<string|int, mixed> $records, Format $format[, mixed $args = null ]) : mixed
Parameters
$records : array<string|int, mixed>
$format : Format
$args : mixed = null

parseOptions()

private parseOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

processOptions()

private processOptions(array<string|int, mixed> $records) : array<string|int, mixed>|object
Parameters
$records : array<string|int, mixed>
Return values
array<string|int, mixed>|object

        
On this page

Search results