1. class
  2. Plugins
  3. \
  4. EmpirePluginsBundle
  5. \
  6. Business
  7. \
  8. Manager
  9. \
  10. PluginConfigManager

PluginConfigManager

class PluginConfigManager implements BasicEntityManagerInterface

Class PluginConfigManager is injected as empire_plugin_config.manager service. PluginConfigManager handles the logic for managed entity.

Properties

protected PluginConfigRepository $repository

Methods

__construct(PluginConfigRepository $repository)

PluginConfigManager constructor.

array
getPluginsForTheme(string $themeName)

Find all plugins for specific theme

PluginConfig|null
getPluginConfig(string $pluginName, string $theme = FRONTEND_THEME_TITLE)

Find plugin configuration for specific theme

bool
update(PluginConfig $plugin)

Merge plugin configuration

bool
updateMultiple(array $plugins)

Merge collection of plugin configurations

bool
saveMultiple(array $plugins)

Persist collection of plugin configurations

bool
emptyConfigForTheme(string $themeName)

Delete theme configuration

bool
updatePluginConfigState(string $pluginName, string $newPluginState)

Update plugin state for specific theme

bool
addPluginConfig(array $pluginDefinition)

Persist collection of plugin configurations

array
findAllActivePluginConfigLayouts()

Find all active plugin configuration templates for specific plugin

array
findAllActivePluginsForTheme(string|null $theme = null)

Find all active plugin names for specific theme

setActivePluginConfigLayouts(array $activeLayouts)

Activate provided plugin layouts

bool
addPluginConfigLayout(string $pluginName, string $layoutName, string $templateName, int $page, string $name, string $image, bool $active)

Add plugin configuration

bool
editPluginConfigLayout(string $pluginName, string $oldTemplateName, string $layoutName, string $templateName, int $page, string $name, string $image, bool $active)

Edit plugin configuration

bool
removeLayouts(string $pluginName, array $templateNames)

Remove layouts

bool
changeTemplateData(array $data)

Change template data

Details

at line 32
__construct(PluginConfigRepository $repository)

PluginConfigManager constructor.

Parameters

PluginConfigRepository $repository

at line 43
array getPluginsForTheme(string $themeName)

Find all plugins for specific theme

Parameters

string $themeName

Return Value

array

at line 55
PluginConfig|null getPluginConfig(string $pluginName, string $theme = FRONTEND_THEME_TITLE)

Find plugin configuration for specific theme

Parameters

string $pluginName
string $theme

Return Value

PluginConfig|null

at line 66
bool update(PluginConfig $plugin)

Merge plugin configuration

Parameters

PluginConfig $plugin

Return Value

bool

at line 77
bool updateMultiple(array $plugins)

Merge collection of plugin configurations

Parameters

array $plugins

Return Value

bool

at line 88
bool saveMultiple(array $plugins)

Persist collection of plugin configurations

Parameters

array $plugins

Return Value

bool

at line 99
bool emptyConfigForTheme(string $themeName)

Delete theme configuration

Parameters

string $themeName

Return Value

bool

at line 111
bool updatePluginConfigState(string $pluginName, string $newPluginState)

Update plugin state for specific theme

Parameters

string $pluginName
string $newPluginState

Return Value

bool

at line 122
bool addPluginConfig(array $pluginDefinition)

Persist collection of plugin configurations

Parameters

array $pluginDefinition

Return Value

bool

at line 151
array findAllActivePluginConfigLayouts()

Find all active plugin configuration templates for specific plugin

Return Value

array

at line 162
array findAllActivePluginsForTheme(string|null $theme = null)

Find all active plugin names for specific theme

Parameters

string|null $theme

Return Value

array

at line 171
setActivePluginConfigLayouts(array $activeLayouts)

Activate provided plugin layouts

Parameters

array $activeLayouts

at line 188
bool addPluginConfigLayout(string $pluginName, string $layoutName, string $templateName, int $page, string $name, string $image, bool $active)

Add plugin configuration

Parameters

string $pluginName
string $layoutName
string $templateName
int $page
string $name
string $image
bool $active

Return Value

bool

at line 217
bool editPluginConfigLayout(string $pluginName, string $oldTemplateName, string $layoutName, string $templateName, int $page, string $name, string $image, bool $active)

Edit plugin configuration

Parameters

string $pluginName
string $oldTemplateName
string $layoutName
string $templateName
int $page
string $name
string $image
bool $active

Return Value

bool

at line 242
bool removeLayouts(string $pluginName, array $templateNames)

Remove layouts

Parameters

string $pluginName
array $templateNames

Return Value

bool

at line 268
bool changeTemplateData(array $data)

Change template data

Parameters

array $data

Return Value

bool