Arikaim CMS

DriverManagerInterface
in

Driver Manager Interface

Table of Contents

Methods

create()  : DriverInterface|null
Create driver
disable()  : bool
Disable driver
enable()  : bool
Enable driver
getConfig()  : Properties
Get driver config
getList()  : array<string|int, mixed>
Get drivers list
has()  : bool
Return true if driver exsits
install()  : bool
Install driver
saveConfig()  : bool
Save driver config
unInstall()  : bool
Uninstall driver

Methods

create()

Create driver

public create(string $name[, array<string|int, mixed> $options = [] ][, array<string|int, mixed>|null $config = null ]) : DriverInterface|null
Parameters
$name : string

Driver name

$options : array<string|int, mixed> = []
$config : array<string|int, mixed>|null = null

Drievr config properties

Return values
DriverInterface|null

disable()

Disable driver

public disable(string $name) : bool
Parameters
$name : string
Return values
bool

enable()

Enable driver

public enable(string $name) : bool
Parameters
$name : string
Return values
bool

getConfig()

Get driver config

public getConfig(string $name) : Properties
Parameters
$name : string

Driver name

Return values
Properties

getList()

Get drivers list

public getList([string|null $category = null ][, int|null $status = null ]) : array<string|int, mixed>
Parameters
$category : string|null = null
$status : int|null = null
Return values
array<string|int, mixed>

has()

Return true if driver exsits

public has(string $name) : bool
Parameters
$name : string

Driver name

Return values
bool

install()

Install driver

public install(string|object $name[, string|null $class = null ][, string|null $category = null ][, string|null $title = null ][, string|null $description = null ][, string|null $version = null ][, array<string|int, mixed> $config = [] ][, string|null $packageName = null ][, string|null $packageType = null ]) : bool
Parameters
$name : string|object

Driver name

$class : string|null = null

full class name or driver object ref

$category : string|null = null
$title : string|null = null
$description : string|null = null
$version : string|null = null
$config : array<string|int, mixed> = []
$packageName : string|null = null
$packageType : string|null = null
Return values
bool

saveConfig()

Save driver config

public saveConfig(string $name, array<string|int, mixed>|object $config) : bool
Parameters
$name : string

Driver name

$config : array<string|int, mixed>|object
Return values
bool

unInstall()

Uninstall driver

public unInstall(string $name) : bool
Parameters
$name : string

Driver name

Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results