Class JPluginHelper

Plugin helper class

Abstract
Package: Joomla\Libraries\Plugin
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.5
Located at cms/plugin/helper.php

Methods summary

`public static string`	# `getLayoutPath( string $type, string $name, string $layout = 'default' )` Get the path to a layout from a Plugin Get the path to a layout from a Plugin Parameters `$type` `string` - $type Plugin type `$name` `string` - $name Plugin name `$layout` `string` - $layout Layout name Returns `string` - Layout path Since 3.0
`public static mixed`	# `getPlugin( string $type, string $plugin = null )` Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned. Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned. Parameters `$type` `string` - $type The plugin type, relates to the subdirectory in the plugins directory. `$plugin` `string` - $plugin The plugin name. Returns `mixed` - An array of plugin data objects, or a plugin data object. Since 1.5
`public static boolean`	# `isEnabled( string $type, string $plugin = null )` Checks if a plugin is enabled. Checks if a plugin is enabled. Parameters `$type` `string` - $type The plugin type, relates to the subdirectory in the plugins directory. `$plugin` `string` - $plugin The plugin name. Returns `boolean` Since 1.5
`public static boolean`	# `importPlugin( string $type, string $plugin = null, boolean $autocreate = true, JEventDispatcher $dispatcher = null )` Loads all the plugin files for a particular type if no specific plugin is specified otherwise only the specific plugin is loaded. Loads all the plugin files for a particular type if no specific plugin is specified otherwise only the specific plugin is loaded. Parameters `$type` `string` - $type The plugin type, relates to the subdirectory in the plugins directory. `$plugin` `string` - $plugin The plugin name. `$autocreate` `boolean` - $autocreate Autocreate the plugin. `$dispatcher` `JEventDispatcher` - $dispatcher Optionally allows the plugin to use a different dispatcher. Returns `boolean` - True on success. Since 1.5
`protected static`	# `_import( object $plugin, boolean $autocreate = true, JEventDispatcher $dispatcher = null )` Loads the plugin file. Loads the plugin file. Deprecated 4.0 Use JPluginHelper::import() instead Parameters `$plugin` `object` - $plugin The plugin. `$autocreate` `boolean` - $autocreate True to autocreate. `$dispatcher` `JEventDispatcher` - $dispatcher Optionally allows the plugin to use a different dispatcher. Since 1.5
`protected static`	# `import( object $plugin, boolean $autocreate = true, JEventDispatcher $dispatcher = null )` Loads the plugin file. Loads the plugin file. Parameters `$plugin` `object` - $plugin The plugin. `$autocreate` `boolean` - $autocreate True to autocreate. `$dispatcher` `JEventDispatcher` - $dispatcher Optionally allows the plugin to use a different dispatcher. Since 3.2
`protected static array`	# `_load( )` Loads the published plugins. Loads the published plugins. Deprecated 4.0 Use JPluginHelper::load() instead Returns `array` - An array of published plugins Since 1.5
`protected static array`	# `load( )` Loads the published plugins. Loads the published plugins. Returns `array` - An array of published plugins Since 3.2

Magic methods summary

Properties summary

`protected static array`	`$plugins`	# A persistent cache of the loaded plugins. A persistent cache of the loaded plugins. Since 1.7

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JPluginHelper

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Deprecated

Parameters

Since

Parameters

Since

Deprecated

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since