Arikaim CMS

Driver
in package
implements DriverInterface Uses Driver

Driver base class

Table of Contents

Interfaces

DriverInterface
Driver interface

Properties

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

Methods

createDriverConfig()  : void
Build driver config properties
getDriverCategory()  : string|null
Return driver category.
getDriverClass()  : string
Get driver class
getDriverConfig()  : array<string|int, mixed>
Get driver config
getDriverConfigVar()  : mixed
Get driver config var
getDriverDescription()  : string|null
Return driver description.
getDriverExtensionName()  : string|null
Return driver extension name (if driver class is located in extension)
getDriverName()  : string
Return driver name.
getDriverOption()  : mixed
Get driver option
getDriverOptions()  : array<string|int, mixed>
Get driver options
getDriverTitle()  : string|null
Return driver display name.
getDriverVersion()  : string|null
Return driver version.
getInstance()  : object
Get driver instance
initDriver()  : void
Initialize driver
setDriverClass()  : void
Set driver class
setDriverConfig()  : void
Set driver config
setDriverOption()  : void
Set driver option
setDriverOptions()  : void
Set driver options
setDriverParams()  : void
Set driver name, title, category, description , version params

Properties

$driverCategory

Driver category

protected string|null $driverCategory = null

$driverClass

Driver class

protected string|null $driverClass = null

$driverConfig

Driver config

protected array<string|int, mixed> $driverConfig = []

$driverDescription

Driver description

protected string|null $driverDescription = null

$driverExtension

Driver extension name

protected string|null $driverExtension = null

$driverName

Driver name

protected string|null $driverName = null

$driverOptions

Driver options

protected array<string|int, mixed> $driverOptions = []

$driverTitle

Driver title (display name)

protected string|null $driverTitle = null

$driverVersion

Driver version

protected string $driverVersion = '1.0.0'

$instance

Driver instance

protected object|null $instance

Methods

createDriverConfig()

Build driver config properties

public createDriverConfig(mixed $properties) : void
Parameters
$properties : mixed

getDriverCategory()

Return driver category.

public getDriverCategory() : string|null
Return values
string|null

getDriverClass()

Get driver class

public getDriverClass() : string
Return values
string

getDriverConfig()

Get driver config

public getDriverConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDriverConfigVar()

Get driver config var

public getDriverConfigVar(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

getDriverDescription()

Return driver description.

public getDriverDescription() : string|null
Return values
string|null

getDriverExtensionName()

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

public getDriverExtensionName() : string|null
Return values
string|null

getDriverName()

Return driver name.

public getDriverName() : string
Return values
string

getDriverOption()

Get driver option

public getDriverOption(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getDriverOptions()

Get driver options

public getDriverOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDriverTitle()

Return driver display name.

public getDriverTitle() : string|null
Return values
string|null

getDriverVersion()

Return driver version.

public getDriverVersion() : string|null
Return values
string|null

getInstance()

Get driver instance

public getInstance() : object
Return values
object

initDriver()

Initialize driver

public initDriver(mixed $properties) : void
Parameters
$properties : mixed

setDriverClass()

Set driver class

public setDriverClass(string $class) : void
Parameters
$class : string

setDriverConfig()

Set driver config

public setDriverConfig(array<string|int, mixed> $config) : void
Parameters
$config : array<string|int, mixed>

setDriverOption()

Set driver option

public setDriverOption(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

setDriverOptions()

Set driver options

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

setDriverParams()

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

public 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 ]) : void
Parameters
$name : string
$category : string|null = null
$title : string|null = null
$description : string|null = null
$version : string|null = null
$extension : string|null = null
$class : string|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results