1. class
  2. Alligator
  3. \
  4. Business
  5. \
  6. Manager
  7. \
  8. PluginSettings
  9. \
  10. PluginSettingsManager

PluginSettingsManager

class PluginSettingsManager implements BasicEntityManagerInterface

Class PluginSettingsManager is injected as alligator.plugin.settings.manager service. PluginSettingsManager handles the logic for managed entity.

Constants

WEB_RESOURCE_DIR

PLUGINS_DIR

DO_NOT_DELETE_KEYS

Methods

__construct(ContainerInterface $container)

PluginSettingsManager constructor.

array
getAllPlugins()

Retrieve all plugins

string|false
exportPlugin(string $pluginName)

Export plugin and generate web path to exported file

boolean
changePluginState(string $pluginName, boolean $newPluginState)

Change state of plugin

bool
uploadPlugin(string $name, string $base64)

Upload plugin from zip

bool
addPluginLayout(string $pluginName, string $layoutName, string $templateName, string $page = 'dashboard.html', string|null $name = null, string|null $image = null, bool $active = true, bool $clearCaches = true)

No description

bool
editPluginLayout(string $pluginName, string $layoutName, string $oldTemplateName, string $templateName, string $page = 'dashboard.html', string|null $name = null, string|null $image = null, bool $clearCaches = true)

Edit plugin layout

bool
removePluginLayouts(string $pluginName, array $templateNames, bool $clearCaches = true)

No description

array
getLayouts(string|null $page = null)

Get layout names for defined page

string
getPluginIcon(string $pluginName)

Retrieve icon for plugin

Details

at line 62
__construct(ContainerInterface $container)

PluginSettingsManager constructor.

Parameters

ContainerInterface $container

at line 72
array getAllPlugins()

Retrieve all plugins

Return Value

array

at line 86
string|false exportPlugin(string $pluginName)

Export plugin and generate web path to exported file

Parameters

string $pluginName

Return Value

string|false False on error, web path to exported plugin otherwise

at line 102
boolean changePluginState(string $pluginName, boolean $newPluginState)

Change state of plugin

Parameters

string $pluginName
boolean $newPluginState

Return Value

boolean

at line 168
bool uploadPlugin(string $name, string $base64)

Upload plugin from zip

Parameters

string $name
string $base64

Return Value

bool

at line 240
bool addPluginLayout(string $pluginName, string $layoutName, string $templateName, string $page = 'dashboard.html', string|null $name = null, string|null $image = null, bool $active = true, bool $clearCaches = true)

Parameters

string $pluginName
string $layoutName
string $templateName
string $page
string|null $name
string|null $image
bool $active
bool $clearCaches

Return Value

bool

at line 311
bool editPluginLayout(string $pluginName, string $layoutName, string $oldTemplateName, string $templateName, string $page = 'dashboard.html', string|null $name = null, string|null $image = null, bool $clearCaches = true)

Edit plugin layout

Parameters

string $pluginName
string $layoutName
string $oldTemplateName
string $templateName
string $page
string|null $name
string|null $image
bool $clearCaches

Return Value

bool

at line 363
bool removePluginLayouts(string $pluginName, array $templateNames, bool $clearCaches = true)

Parameters

string $pluginName
array $templateNames
bool $clearCaches

Return Value

bool

at line 407
array getLayouts(string|null $page = null)

Get layout names for defined page

Parameters

string|null $page

Return Value

array

at line 433
string getPluginIcon(string $pluginName)

Retrieve icon for plugin

Parameters

string $pluginName

Return Value

string