Arikaim CMS

DriverInterface
in

Driver interface

Table of Contents

Methods

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

Methods

createDriverConfig()

Build driver config properties array

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

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>

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|null
Return values
string|null

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

setDriverConfig()

Set driver config

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

setDriverOptions()

Set driver options

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

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results