Heratio Framework API Reference

ExtensionManager
in package
implements ExtensionManagerContract

Table of Contents

Interfaces

ExtensionManagerContract

Methods

__construct()  : mixed
all()  : Collection
Get all registered extensions
checkComposerDependencies()  : array<string|int, mixed>
Check if composer dependencies are installed
disable()  : bool
Disable an extension (auto-disables dependents)
discover()  : Collection
Discover all extensions with extension.json in plugins directory and atom-ahg-plugins
enable()  : bool
Enable an extension (auto-enables dependencies)
find()  : array<string|int, mixed>|null
Find extension by machine name
findAllDependents()  : array<string|int, mixed>
Scan ALL plugins to find who depends on the given plugin
findLocalPluginPath()  : string|null
Check if a plugin exists locally (in plugins/ or atom-ahg-plugins/)
getAhgPluginsPath()  : string|null
Get the path to atom-ahg-plugins directory
getAuditLog()  : Collection
getByStatus()  : Collection
Get extensions by status
getComposerDependencies()  : array<string|int, mixed>
Get composer dependencies from extension.json
getDependencies()  : array<string|int, mixed>
Get plugin dependencies from extension.json (excludes composer packages)
getDependencyTree()  : array<string|int, mixed>
Get full dependency tree for display
getDependents()  : array<string|int, mixed>
Get dependents from extension.json
getSetting()  : mixed
Get extension setting
install()  : bool
Install an extension (with dependency chain)
isEnabled()  : bool
Check if extension is enabled
isInstalled()  : bool
Check if extension is installed
logAudit()  : void
processPendingDeletions()  : array<string|int, mixed>
restore()  : bool
Restore a pending deletion
setSetting()  : bool
Set extension setting
uninstall()  : bool
Uninstall an extension
updateVersion()  : bool

Methods

all()

Get all registered extensions

public all() : Collection
Return values
Collection

checkComposerDependencies()

Check if composer dependencies are installed

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

disable()

Disable an extension (auto-disables dependents)

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

discover()

Discover all extensions with extension.json in plugins directory and atom-ahg-plugins

public discover([bool $includeThemes = false ]) : Collection
Parameters
$includeThemes : bool = false
Return values
Collection

enable()

Enable an extension (auto-enables dependencies)

public enable(string $machineName[, bool $enableDependencies = true ]) : bool
Parameters
$machineName : string
$enableDependencies : bool = true
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

findAllDependents()

Scan ALL plugins to find who depends on the given plugin

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

findLocalPluginPath()

Check if a plugin exists locally (in plugins/ or atom-ahg-plugins/)

public findLocalPluginPath(string $machineName) : string|null
Parameters
$machineName : string
Return values
string|null

getAhgPluginsPath()

Get the path to atom-ahg-plugins directory

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

getAuditLog()

public getAuditLog([string|null $machineName = null ][, int $limit = 50 ]) : Collection
Parameters
$machineName : string|null = null
$limit : int = 50
Return values
Collection

getByStatus()

Get extensions by status

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

getComposerDependencies()

Get composer dependencies from extension.json

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

getDependencies()

Get plugin dependencies from extension.json (excludes composer packages)

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

getDependencyTree()

Get full dependency tree for display

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

getDependents()

Get dependents from extension.json

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

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 (with dependency chain)

public install(string $machineName[, bool $installDependencies = true ]) : bool
Parameters
$machineName : string
$installDependencies : bool = true
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

logAudit()

public logAudit(string $machineName, string $action[, array<string|int, mixed>|null $details = null ]) : void
Parameters
$machineName : string
$action : string
$details : array<string|int, mixed>|null = null

processPendingDeletions()

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

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

updateVersion()

public updateVersion(string $machineName, string $newVersion) : bool
Parameters
$machineName : string
$newVersion : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results