PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of PluginHelper.php

Joomla! Content Management System

Copyright:	(C) 2005 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	294 lines (9 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 6 functions

  getLayoutPath()
  getPlugin()
  isEnabled()
  importPlugin()
  import()
  load()

Functions

Functions that are not part of a class:

getLayoutPath($type, $name, $layout = 'default') X-Ref

Get the path to a layout from a Plugin

param: string  $type    Plugin type
param: string  $name    Plugin name
param: string  $layout  Layout name
return: string  Layout path

getPlugin($type, $plugin = null) X-Ref

Get the plugin data of a specific type if no specific plugin is specified
otherwise only the specific plugin data is returned.

param: string  $type    The plugin type, relates to the subdirectory in the plugins directory.
param: string  $plugin  The plugin name.
return: mixed  An array of plugin data objects, or a plugin data object.

isEnabled($type, $plugin = null) X-Ref

Checks if a plugin is enabled.

param: string $type The plugin type, relates to the subdirectory in the plugins directory.
param: string $plugin The plugin name.
return: boolean

importPlugin($type, $plugin = null, $autocreate = true, DispatcherInterface $dispatcher = null) X-Ref

Loads all the plugin files for a particular type if no specific plugin is specified
otherwise only the specific plugin is loaded.

param: string               $type        The plugin type, relates to the subdirectory in the plugins directory.
param: string               $plugin      The plugin name.
param: boolean              $autocreate  Autocreate the plugin.
param: DispatcherInterface  $dispatcher  Optionally allows the plugin to use a different dispatcher.
return: boolean  True on success.

import($plugin, $autocreate = true, DispatcherInterface $dispatcher = null) X-Ref

Loads the plugin file.

param: object               $plugin      The plugin.
param: boolean              $autocreate  True to autocreate.
param: DispatcherInterface  $dispatcher  Optionally allows the plugin to use a different dispatcher.
return: void

load() X-Ref

Loads the published plugins.

return: array An array of published plugins

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Plugin/ -> PluginHelper.php (summary)

Defines 6 functions