CJAX 6.0 Beta 2
\
CJAX
Core
Event
Plugin
ExamplePlugin
Controllers
Plugins
Autocomplete
Controllers
Dracula
Controllers
Uploader
Controllers
Uploadify
Controllers
Validate
Controllers
Examples
Controllers

\CJAX\CorePluginManager

The PluginManager class that stores and manages a collection of plugins and handles their operations.

Summary

Methods
Properties
Constants
__construct()
isPlugin()
getPlugin()
instanceTriggers()
initiate()
isAborted()
trigger()
file()
method()
dir()
plugin()
readDir()
hasClass()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
loadClass()
$coreEvents
$instances
$classes
$aborted
$meta
$dirs
$readDir
N/A

Properties

$coreEvents

$coreEvents : \CJAX\Core\CoreEvents

The coreEvents property, stores an instance of injected CoreEvents object.

Type

\CJAX\Core\CoreEvents

$instances

$instances : array

The instances property, stores an array of instantiated plugin objects.

Type

array

$classes

$classes : array

The classes property, stores an array of plugin class names.

Type

array

$aborted

$aborted : array

The aborted property, specifies an array of aborted plugins.

Type

array

$meta

$meta : array

The meta property, defines an array of plugin metadata.

Type

array

$dirs

$dirs : array

The dirs property, defines an array of plugin directories.

Type

array

$readDir

$readDir : array

The readDir property, specifies recently read/processed plugin directories.

Type

array

Methods

__construct()

__construct(\CJAX\Core\CoreEvents  $coreEvents) : \CJAX\Core\PluginManager

The constructor for PluginManager class, creates an instance of PluginManager object.

Parameters

\CJAX\Core\CoreEvents $coreEvents

Returns

\CJAX\Core\PluginManager

isPlugin()

isPlugin(string  $pluginName) : boolean

The isPlugin method, check if a plugin exists given its name.

Parameters

string $pluginName

Returns

boolean

getPlugin()

getPlugin(string  $pluginName = null, array  $params = array(), string  $instanceId = null, boolean  $loadController = false) : \CJAX\Core\Plugin

The getPlugin method, check if a plugin exists given its name.

Parameters

string $pluginName
array $params
string $instanceId
boolean $loadController

Returns

\CJAX\Core\Plugin

instanceTriggers()

instanceTriggers(\CJAX\Core\Plugin  $plugin, array  $params) : \CJAX\Core\Plugin

The instanceTriggers method, triggers a method call for a plugin object.

Parameters

\CJAX\Core\Plugin $plugin
array $params

Returns

\CJAX\Core\Plugin

initiate()

initiate() : void

The initiate method, initializes plugin manager's actions/operations.

isAborted()

isAborted(string  $pluginName = null) : boolean

The isAborted method, checks if a plugin has been aborted.

Parameters

string $pluginName

Returns

boolean

trigger()

trigger(string  $event, array  $params = array()) : boolean

The trigger method, triggers plugin event handling.

Parameters

string $event
array $params

Returns

boolean

file()

file(string  $pluginName) : string

The file method, gets full path of a given plugin.

Parameters

string $pluginName

Returns

string

method()

method(string  $pluginName) : string

The method method, gets the method name of a given plugin.

Parameters

string $pluginName

Returns

string

dir()

dir(string  $pluginName = null) : string

The dir method, gets the path of plugin's directory.

Parameters

string $pluginName

Returns

string

plugin()

plugin(string  $pluginName, boolean  $loadController = false) : \CJAX\Core\Plugin

The plugin method, fetches a plugin given its name.

Parameters

string $pluginName
boolean $loadController

Returns

\CJAX\Core\Plugin

readDir()

readDir(string  $resource) : array

The readDir method, reads directory information for plugins.

Parameters

string $resource

Returns

array

hasClass()

hasClass(string  $pluginName) : boolean

The hasClass method, checks if a plugin has a custom class defined.

Parameters

string $pluginName

Returns

boolean

loadClass()

loadClass(object  $obj, string  $class) : void

The loadClass method, loads plugin class if exists.

Parameters

object $obj
string $class