1. class
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Driver
  7. \
  8. Driver

Driver

class Driver implements DriverInterface

Driver base class

Traits

Driver
Driver trait

Properties

protected string|null $driverName Driver name from Driver
protected string|null $driverClass Driver class from Driver
protected string $driverVersion Driver version from Driver
protected string|null $driverTitle Driver title (display name) from Driver
protected string|null $driverDescription Driver description from Driver
protected string|null $driverCategory Driver category from Driver
protected array $driverConfig Driver config from Driver
protected array $driverOptions Driver options from Driver
protected string|null $driverExtension Driver extension name from Driver
protected object|null $instance Driver instance from Driver

Methods

string|null
getDriverName()

Return driver name.

from Driver
object
getInstance()

Get driver instance

from Driver
string|null
getDriverTitle()

Return driver display name.

from Driver
string|null
getDriverDescription()

Return driver description.

from Driver
string|null
getDriverCategory()

Return driver category.

from Driver
string|null
getDriverVersion()

Return driver version.

from Driver
string|null
getDriverExtensionName()

Return driver extension name (if driver class is located in extension)

from Driver
string
getDriverClass()

Get driver class

from Driver
void
setDriverClass(string $class)

Set driver class

from Driver
array
getDriverConfig()

Get driver config

from Driver
void
setDriverConfig(array $config)

Set driver config

from Driver
mixed
getDriverConfigVar(string $key, mixed $default = null)

Get driver config var

from Driver
void
setDriverParams(string $name, string|null $category = null, string|null $title = null, string|null $description = null, string|null $version = null, string|null $extension = null, string|null $class = null)

Set driver name, title, category, description , version params

from Driver
void
initDriver($properties)

Initialize driver

from Driver
array
createDriverConfig($properties)

Build driver config properties

from Driver
mixed
getDriverOption(string $name, mixed $default = null)

Get driver option

from Driver
void
setDriverOption(string $name, mixed $value)

Set driver option

from Driver
void
setDriverOptions(array $options)

Set driver options

from Driver
array
getDriverOptions()

Get driver options

from Driver
__construct()

Constructor

Details

in Driver at line 92
string|null getDriverName()

Return driver name.

Return Value

string|null

in Driver at line 102
object getInstance()

Get driver instance

Return Value

object

in Driver at line 112
string|null getDriverTitle()

Return driver display name.

Return Value

string|null

in Driver at line 122
string|null getDriverDescription()

Return driver description.

Return Value

string|null

in Driver at line 132
string|null getDriverCategory()

Return driver category.

Return Value

string|null

in Driver at line 142
string|null getDriverVersion()

Return driver version.

Return Value

string|null

in Driver at line 152
string|null getDriverExtensionName()

Return driver extension name (if driver class is located in extension)

Return Value

string|null

in Driver at line 162
string getDriverClass()

Get driver class

Return Value

string

in Driver at line 173
void setDriverClass(string $class)

Set driver class

Parameters

string $class

Return Value

void

in Driver at line 183
array getDriverConfig()

Get driver config

Return Value

array

in Driver at line 194
void setDriverConfig(array $config)

Set driver config

Parameters

array $config

Return Value

void

in Driver at line 206
mixed getDriverConfigVar(string $key, mixed $default = null)

Get driver config var

Parameters

string $key
mixed $default

Return Value

mixed

in Driver at line 223
void setDriverParams(string $name, string|null $category = null, string|null $title = null, string|null $description = null, string|null $version = null, string|null $extension = null, string|null $class = null)

Set driver name, title, category, description , version params

Parameters

string $name
string|null $category
string|null $title
string|null $description
string|null $version
string|null $extension
string|null $class

Return Value

void

in Driver at line 246
void initDriver($properties)

Initialize driver

Parameters

$properties

Return Value

void

in Driver at line 259
array createDriverConfig($properties)

Build driver config properties

Parameters

$properties

Return Value

array

in Driver at line 270
mixed getDriverOption(string $name, mixed $default = null)

Get driver option

Parameters

string $name
mixed $default

Return Value

mixed

in Driver at line 282
void setDriverOption(string $name, mixed $value)

Set driver option

Parameters

string $name
mixed $value

Return Value

void

in Driver at line 293
void setDriverOptions(array $options)

Set driver options

Parameters

array $options

Return Value

void

in Driver at line 303
array getDriverOptions()

Get driver options

Return Value

array

at line 25
__construct()

Constructor