Heratio Framework API Reference

ExtensionManagerContract
in

Table of Contents

Methods

all()  : Collection
Get all registered extensions
disable()  : bool
Disable an extension
discover()  : Collection
Discover all available extensions in the plugins directory
enable()  : bool
Enable an extension
find()  : array<string|int, mixed>|null
Find extension by machine name
getByStatus()  : Collection
Get extensions by status
getSetting()  : mixed
Get extension setting
install()  : bool
Install an extension
isEnabled()  : bool
Check if extension is enabled
isInstalled()  : bool
Check if extension is installed
restore()  : bool
Restore a pending deletion
setSetting()  : bool
Set extension setting
uninstall()  : bool
Uninstall an extension

Methods

disable()

Disable an extension

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

discover()

Discover all available extensions in the plugins directory

public discover() : Collection
Return values
Collection

enable()

Enable an extension

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

find()

Find extension by machine name

public find(string $machineName) : array<string|int, mixed>|null
Parameters
$machineName : string
Return values
array<string|int, mixed>|null

getByStatus()

Get extensions by status

public getByStatus(string $status) : Collection
Parameters
$status : string
Return values
Collection

getSetting()

Get extension setting

public getSetting(string $key[, int|null $extensionId = null ][, mixed $default = null ]) : mixed
Parameters
$key : string
$extensionId : int|null = null
$default : mixed = null

install()

Install an extension

public install(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

isEnabled()

Check if extension is enabled

public isEnabled(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

isInstalled()

Check if extension is installed

public isInstalled(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

restore()

Restore a pending deletion

public restore(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

setSetting()

Set extension setting

public setSetting(string $key, mixed $value[, int|null $extensionId = null ]) : bool
Parameters
$key : string
$value : mixed
$extensionId : int|null = null
Return values
bool

uninstall()

Uninstall an extension

public uninstall(string $machineName[, bool $backup = true ]) : bool
Parameters
$machineName : string
$backup : bool = true
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results