Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe PluginHelper

Fonctions membres publiques statiques

static getLayoutPath ($type, $name, $layout='default')
 
static getPlugin ($type, $plugin=null)
 
static isEnabled ($type, $plugin=null)
 
static importPlugin ($type, $plugin=null, $autocreate=true, \JEventDispatcher $dispatcher=null)
 

Fonctions membres protégées statiques

static _import ($plugin, $autocreate=true, \JEventDispatcher $dispatcher=null)
 
static import ($plugin, $autocreate=true, \JEventDispatcher $dispatcher=null)
 
static _load ()
 

Attributs protégés statiques

static $plugins = null
 

Description détaillée

Plugin helper class

Depuis
1.5

Documentation des fonctions membres

◆ _import()

static _import (   $plugin,
  $autocreate = true,
\JEventDispatcher  $dispatcher = null 
)
staticprotected

Loads the plugin file.

Paramètres
object$pluginThe plugin.
boolean$autocreateTrue to autocreate.
\JEventDispatcher$dispatcherOptionally allows the plugin to use a different dispatcher.
Renvoie
void
Depuis
1.5
Obsolète:
4.0 Use PluginHelper::import() instead

Références $dispatcher.

◆ _load()

static _load ( )
staticprotected

Loads the published plugins.

Renvoie
array An array of published plugins
Depuis
1.5
Obsolète:
4.0 Use PluginHelper::load() instead

◆ getLayoutPath()

static getLayoutPath (   $type,
  $name,
  $layout = 'default' 
)
static

Get the path to a layout from a Plugin

Paramètres
string$typePlugin type
string$namePlugin name
string$layoutLayout name
Renvoie
string Layout path
Depuis
3.0

Références $layout, $name, $template, $type, elseif, JPATH_PLUGINS, et JPATH_THEMES.

◆ getPlugin()

static getPlugin (   $type,
  $plugin = null 
)
static

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

Paramètres
string$typeThe plugin type, relates to the subdirectory in the plugins directory.
string$pluginThe plugin name.
Renvoie
mixed An array of plugin data objects, or a plugin data object.
Depuis
1.5

Références $type.

Référencé par Captcha\_load(), Authentication\authenticate(), CMSHelper\getCurrentLanguage(), et ContentHelper\getCurrentLanguage().

◆ import()

static import (   $plugin,
  $autocreate = true,
\JEventDispatcher  $dispatcher = null 
)
staticprotected

Loads the plugin file.

Paramètres
object$pluginThe plugin.
boolean$autocreateTrue to autocreate.
\JEventDispatcher$dispatcherOptionally allows the plugin to use a different dispatcher.
Renvoie
void
Depuis
3.2

Références $className, $dispatcher, $path, JEventDispatcher\getInstance(), et JPATH_PLUGINS.

◆ importPlugin()

static importPlugin (   $type,
  $plugin = null,
  $autocreate = true,
\JEventDispatcher  $dispatcher = null 
)
static

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

Paramètres
string$typeThe plugin type, relates to the subdirectory in the plugins directory.
string$pluginThe plugin name.
boolean$autocreateAutocreate the plugin.
\JEventDispatcher$dispatcherOptionally allows the plugin to use a different dispatcher.
Renvoie
boolean True on success.
Depuis
1.5

Références $dispatcher, $i, $results, $type, JEventDispatcher\getInstance(), name, et null.

Référencé par Authentication\__construct(), Authentication\authorise(), User\delete(), Installer\discover_install(), InstallerHelper\downloadPackage(), UserHelper\getProfile(), Installer\install(), User\save(), Installer\uninstall(), et Installer\update().

◆ isEnabled()

static isEnabled (   $type,
  $plugin = null 
)
static

Checks if a plugin is enabled.

Paramètres
string$typeThe plugin type, relates to the subdirectory in the plugins directory.
string$pluginThe plugin name.
Renvoie
boolean
Depuis
1.5

Références $type.

Documentation des champs

◆ $plugins

$plugins = null
staticprotected

La documentation de cette classe a été générée à partir du fichier suivant :