\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

$events :array

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

$settings :array

array—the plugin settings

$plugin :array

array—plugin attributes

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

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(array  $settings = null): void

inject settings

backwards compatibility to Phile 1.4

array

$settings

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

implements EventObserverInterface

string	$eventKey
null\|array	$eventData

getPluginPath(string  $subPath = ''): string

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

string

$subPath

string