Heratio Framework API Reference

PluginManagerService
in package
implements PluginManagerContract

Table of Contents

Interfaces

PluginManagerContract

Methods

__construct()  : mixed
canDisable()  : array<string|int, mixed>
canEnable()  : array<string|int, mixed>
clearCaches()  : bool
disablePlugin()  : bool
enablePlugin()  : bool
getAllPlugins()  : array<string|int, mixed>
getAuditLog()  : array<string|int, mixed>
getCategories()  : array<string|int, mixed>
getDependencies()  : array<string|int, mixed>
getDependents()  : array<string|int, mixed>
getEnabledPlugins()  : array<string|int, mixed>
getPlugin()  : array<string|int, mixed>|null
isEnabled()  : bool
registerPlugin()  : int
resolveDependencyTree()  : array<string|int, mixed>
syncPluginsFromFilesystem()  : array<string|int, mixed>
updateSettings()  : bool
validatePluginConfig()  : array<string|int, mixed>

Methods

canDisable()

public canDisable(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

canEnable()

public canEnable(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

disablePlugin()

public disablePlugin(string $name[, int|null $userId = null ][, string|null $reason = null ][, bool $force = false ]) : bool
Parameters
$name : string
$userId : int|null = null
$reason : string|null = null
$force : bool = false
Return values
bool

enablePlugin()

public enablePlugin(string $name[, int|null $userId = null ][, string|null $reason = null ]) : bool
Parameters
$name : string
$userId : int|null = null
$reason : string|null = null
Return values
bool

getAllPlugins()

public getAllPlugins([array<string|int, mixed> $filters = [] ]) : array<string|int, mixed>
Parameters
$filters : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getAuditLog()

public getAuditLog([string|null $pluginName = null ][, int $limit = 50 ]) : array<string|int, mixed>
Parameters
$pluginName : string|null = null
$limit : int = 50
Return values
array<string|int, mixed>

getCategories()

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

getDependencies()

public getDependencies(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

getDependents()

public getDependents(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

getEnabledPlugins()

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

getPlugin()

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

isEnabled()

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

registerPlugin()

public registerPlugin(array<string|int, mixed> $pluginData) : int
Parameters
$pluginData : array<string|int, mixed>
Return values
int

resolveDependencyTree()

public resolveDependencyTree(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

syncPluginsFromFilesystem()

public syncPluginsFromFilesystem(string $pluginsPath) : array<string|int, mixed>
Parameters
$pluginsPath : string
Return values
array<string|int, mixed>

updateSettings()

public updateSettings(string $name, array<string|int, mixed> $settings) : bool
Parameters
$name : string
$settings : array<string|int, mixed>
Return values
bool

validatePluginConfig()

public validatePluginConfig(string $pluginPath) : array<string|int, mixed>
Parameters
$pluginPath : string
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results