Heratio Framework API Reference

PluginFetcher
in package

Table of Contents

Methods

__construct()  : mixed
__destruct()  : mixed
fetch()  : bool
Fetch a specific plugin from GitHub
getAvailableUpdates()  : array<string|int, mixed>
Get all available updates for installed plugins
getRemoteManifest()  : array<string|int, mixed>|null
Get remote manifest for a specific plugin
getRemotePlugins()  : array<string|int, mixed>
Get list of available remote plugins (including themes)
hasUpdate()  : string|null
Check if update is available for a plugin

Methods

__construct()

public __construct([string|null $pluginsPath = null ]) : mixed
Parameters
$pluginsPath : string|null = null

fetch()

Fetch a specific plugin from GitHub

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

getAvailableUpdates()

Get all available updates for installed plugins

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

getRemoteManifest()

Get remote manifest for a specific plugin

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

getRemotePlugins()

Get list of available remote plugins (including themes)

public getRemotePlugins([bool $includeThemes = true ]) : array<string|int, mixed>
Parameters
$includeThemes : bool = true
Return values
array<string|int, mixed>

hasUpdate()

Check if update is available for a plugin

public hasUpdate(string $machineName, string $currentVersion) : string|null
Parameters
$machineName : string
$currentVersion : string
Return values
string|null

        
On this page

Search results