\Phile\PluginAbstractPlugin

the AbstractPlugin class for implementing a plugin for PhileCMS

Summary

Methods
Properties
Constants
initializePlugin()
injectSettings()
on()
No public properties found
No constants found
getPluginPath()
$events
$settings
N/A
No private methods found
$plugin
N/A

Properties

$events

$events :array

Type

array—subscribed Phile events ['eventName' => 'classMethodToCall']

$settings

$settings :array

Type

array—the plugin settings

$plugin

$plugin :array

Type

array—plugin attributes

Methods

initializePlugin()

initializePlugin(string  $pluginKey,string  $pluginDir,\Phile\Core\Event  $eventBus,\Phile\Core\Config  $config): void

Initializes the plugin.

try to keep all initialization in one method to have a clean class for the plugin-user

Parameters

string $pluginKey
string $pluginDir

Root plugin directory this plugin is placed in.

\Phile\Core\Event $eventBus

Phile application event-bus.

\Phile\Core\Config $config

Phile application configuration.

injectSettings()

injectSettings(array  $settings = null): void

inject settings

backwards compatibility to Phile 1.4

Parameters

array $settings

on()

on(string  $eventKey,null|array  $eventData = null): void

implements EventObserverInterface

Parameters

string $eventKey
null|array $eventData

getPluginPath()

getPluginPath(string  $subPath = ''): string

get file path to plugin root (trailing slash) or to a sub-item

Parameters

string $subPath

Returns

string