Heratio Framework API Reference

SfProjectConfigurationShim
in package

Standalone sfProjectConfiguration shim.

Provides the getActive()->getPlugins() API that AHG plugin actions and templates use to check which plugins are enabled.

In Symfony mode, the real sfProjectConfiguration is loaded by the framework. In standalone mode (heratio.php), this shim queries the atom_plugin table instead.

Table of Contents

Methods

enablePlugins()  : void
Enable plugins (no-op in standalone — plugins are DB-driven).
getActive()  : self
Get the active project configuration instance.
getEventDispatcher()  : mixed
Get the event dispatcher.
getPluginPaths()  : array<string|int, mixed>
Get plugin paths (root directories).
getPlugins()  : array<string|int, string>
Get the list of enabled plugins.
getPluginSubPaths()  : array<string|int, mixed>
Get plugin sub-paths (model dirs, lib dirs, etc.).
getRootDir()  : string
Get the root directory.
isPluginEnabled()  : mixed
Check if a specific plugin is enabled.
setPlugins()  : void
Set the plugins list.

Methods

enablePlugins()

Enable plugins (no-op in standalone — plugins are DB-driven).

public enablePlugins(mixed $plugins) : void
Parameters
$plugins : mixed

getEventDispatcher()

Get the event dispatcher.

public getEventDispatcher() : mixed

sfPluginConfiguration constructor calls $configuration->getEventDispatcher(). Returns the SfEventDispatcherAdapter for standalone mode.

No return type hint — must match real sfProjectConfiguration signature, and SfEventDispatcherAdapter lives in SfContextAdapter.php (multi-class file).

getPluginPaths()

Get plugin paths (root directories).

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

getPlugins()

Get the list of enabled plugins.

public getPlugins() : array<string|int, string>

Queries atom_plugin table for enabled OR core plugins. Core plugins (is_core=1) are always loaded regardless of is_enabled flag.

Return values
array<string|int, string>

Plugin names

getPluginSubPaths()

Get plugin sub-paths (model dirs, lib dirs, etc.).

public getPluginSubPaths([mixed $subPath = '/lib/model' ]) : array<string|int, mixed>
Parameters
$subPath : mixed = '/lib/model'
Return values
array<string|int, mixed>

isPluginEnabled()

Check if a specific plugin is enabled.

public isPluginEnabled(mixed $name) : mixed

No type hints — must match ProjectConfiguration::isPluginEnabled($pluginName).

Parameters
$name : mixed

setPlugins()

Set the plugins list.

public setPlugins(array<string|int, string> $plugins) : void

Called by plugin configurations (e.g. theme) to reorder plugins. In standalone mode, updates the in-memory list.

Parameters
$plugins : array<string|int, string>

Plugin names


        
On this page

Search results