Class Plugin

A plugin provides means to extend an application with new functionality without requiring changes to the application itself.

An application makes use of a plugin manager to load plugins during startup (i.e. from a configuration file) and implements hooks to delegate control to plugins to extend the functionality of certain aspects. Plugins can additionally use existing framework methods to extend existing classes, such as attaching a new method.

Small plugins can implement their full functionality within a single file by providing a range of callback methods that process or extend data provided by the application. They may additionally provide new encoders, processor and other data types that are used by the application.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Plugin

Abstract
Namespace: Core
Package: Core\Plugin
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Plugin.inc.php

Methods summary

`abstract public boolean`	# `onZoneLoad( Core\Plugin\Zone $zone )` Callback invoked once a zone the plugin registered for is loaded. Zones are usually loaded on first activity once, hence if a zone is not active, it might never be loaded. Callback invoked once a zone the plugin registered for is loaded. Zones are usually loaded on first activity once, hence if a zone is not active, it might never be loaded. Parameters `$zone` Zone that is being loaded. Returns boolean `true` on success, `null` to un-register or any other return value to indicate an error. If `null` is returned, the plugin is un-registered from the zone. Any other return value is treated as details on the error, e.g. a returned string will be treated as an error description. Remark Plugin implementations should register for all callbacks they plan to hook in and set up environment parameters. See `Core\Plugin::zones()` Since 3.1
`public static string[]`	# `zones( )` Returns an array of zones the plugin should be registered for. Returns an array of zones the plugin should be registered for. Returns string[] Array of zone names to enable the plugin for. Remark Plugins must implement this method to return an array of zones they use. Registration of zone callbacks is requested once a registered zone is loaded. See `Core\Plugin::onZoneLoad()` Since 3.1

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions