trait Driver

Driver trait

Properties

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

Methods

string|null
getDriverName()

Return driver name.

object
getInstance()

Get driver instance

string|null
getDriverTitle()

Return driver display name.

string|null
getDriverDescription()

Return driver description.

string|null
getDriverCategory()

Return driver category.

string|null
getDriverVersion()

Return driver version.

string|null
getDriverExtensionName()

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

string
getDriverClass()

Get driver class

void
setDriverClass(string $class)

Set driver class

array
getDriverConfig()

Get driver config

void
setDriverConfig(array $config)

Set driver config

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

Get driver config var

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

void
initDriver($properties)

Initialize driver

array
createDriverConfig($properties)

Build driver config properties

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

Get driver option

void
setDriverOption(string $name, mixed $value)

Set driver option

void
setDriverOptions(array $options)

Set driver options

array
getDriverOptions()

Get driver options

Details

at line 92
string|null getDriverName()

Return driver name.

Return Value

string|null

at line 102
object getInstance()

Get driver instance

Return Value

object

at line 112
string|null getDriverTitle()

Return driver display name.

Return Value

string|null

at line 122
string|null getDriverDescription()

Return driver description.

Return Value

string|null

at line 132
string|null getDriverCategory()

Return driver category.

Return Value

string|null

at line 142
string|null getDriverVersion()

Return driver version.

Return Value

string|null

at line 152
string|null getDriverExtensionName()

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

Return Value

string|null

at line 162
string getDriverClass()

Get driver class

Return Value

string

at line 173
void setDriverClass(string $class)

Set driver class

Parameters

string $class

Return Value

void

at line 183
array getDriverConfig()

Get driver config

Return Value

array

at line 194
void setDriverConfig(array $config)

Set driver config

Parameters

array $config

Return Value

void

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

Get driver config var

Parameters

string $key
mixed $default

Return Value

mixed

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

at line 246
void initDriver($properties)

Initialize driver

Parameters

$properties

Return Value

void

at line 259
array createDriverConfig($properties)

Build driver config properties

Parameters

$properties

Return Value

array

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

Get driver option

Parameters

string $name
mixed $default

Return Value

mixed

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

Set driver option

Parameters

string $name
mixed $value

Return Value

void

at line 293
void setDriverOptions(array $options)

Set driver options

Parameters

array $options

Return Value

void

at line 303
array getDriverOptions()

Get driver options

Return Value

array