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 ComponentHelper

Fonctions membres publiques statiques

static getComponent ($option, $strict=false)
 
static isEnabled ($option)
 
static isInstalled ($option)
 
static getParams ($option, $strict=false)
 
static filterText ($text)
 
static renderComponent ($option, $params=array())
 
static getComponents ()
 

Fonctions membres protégées statiques

static executeComponent ($path)
 
static _load ($option)
 

Attributs protégés statiques

static $components = array()
 

Description détaillée

Component helper class

Depuis
1.5

Documentation des fonctions membres

◆ _load()

static _load (   $option)
staticprotected

Load the installed components into the components property.

Paramètres
string$optionThe element value for the extension
Renvoie
boolean True on success
Depuis
1.5
Obsolète:
4.0 Use JComponentHelper::load() instead

Références $option.

◆ executeComponent()

static executeComponent (   $path)
staticprotected

Execute the component.

Paramètres
string$pathThe component path.
Renvoie
string The component output
Depuis
1.7

Références $path.

◆ filterText()

static filterText (   $text)
static

Applies the global text filters to arbitrary text as per settings for current user groups

Paramètres
string$textThe string to filter
Renvoie
string The filtered string
Depuis
2.5

Références $attributes, $config, $filter, $filters, $text, $user, elseif, et Access\getGroupsByUser().

◆ getComponent()

static getComponent (   $option,
  $strict = false 
)
static

Get the component information.

Paramètres
string$optionThe component option.
boolean$strictIf set and the component does not exist, the enabled attribute will be set to false.
Renvoie
ComponentRecord An object with the information for the component.
Depuis
1.5

Références $option, et false.

Référencé par MenuRules\buildLookup(), et RouteHelper\findItem().

◆ getComponents()

static getComponents ( )
static

Get installed components

Renvoie
ComponentRecord[] The components property
Depuis
3.6.3

Référencé par SiteRouter\parse().

◆ getParams()

◆ isEnabled()

static isEnabled (   $option)
static

Checks if the component is enabled

Paramètres
string$optionThe component option.
Renvoie
boolean
Depuis
1.5

Références $option.

Référencé par FileLayout\validComponent().

◆ isInstalled()

static isInstalled (   $option)
static

Checks if a component is installed

Paramètres
string$optionThe component option.
Renvoie
integer
Depuis
3.4

Références $option.

◆ renderComponent()

static renderComponent (   $option,
  $params = array() 
)
static

Render the component.

Paramètres
string$optionThe component option.
array$paramsThe component parameters
Renvoie
string
Depuis
1.5
Exceptions
MissingComponentException

Références $app, $file, $lang, $option, $path, $template, JDEBUG, JPATH_ADMINISTRATOR, JPATH_BASE, JPATH_SITE, JPATH_THEMES, et null.

Référencé par AdministratorApplication\dispatch(), et SiteApplication\dispatch().

Documentation des champs

◆ $components

$components = array()
staticprotected

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