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	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

$option

The 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

$path

The 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

$text

The 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	$option	The component option.
boolean	$strict	If 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()

static getParams (   $option,   $strict = false  )

static

Gets the parameter object for the component

Paramètres

string	$option	The option for the component.
boolean	$strict	If set and the component does not exist, false will be returned

Renvoie

Registry A Registry object.

Voir également

Registry

Depuis

1.5

Références $option.

Référencé par TagField\__construct(), MediaHelper\canUpload(), MediaHelper\checkMimeType(), CMSHelper\getCurrentLanguage(), ContentHelper\getCurrentLanguage(), TagsHelper\getItemTags(), MediaField\getLayoutData(), ModuleHelper\getModules(), TagField\getOptions(), SiteApplication\getParams(), AdministratorApplication\initialiseApp(), SiteApplication\initialiseApp(), ModuleHelper\isAdminMultilang(), SearchHelper\logSearch(), Router\parse(), ModuleHelper\renderModule(), ContentHistoryHelper\store(), ApplicationHelper\stringURLSafe(), PasswordRule\test(), EmailRule\test(), et LanguageAdapter\uninstall().

isEnabled()

static isEnabled (   $option )

static

Checks if the component is enabled

Paramètres

string

$option

The 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

$option

The component option.

Renvoie

integer

Depuis

3.4

Références $option.

Documentation des champs

$components

$components = array()

staticprotected

---

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

• ComponentHelper.php