Class JComponentHelper

Component helper class

Package: Joomla\Libraries\Component
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/component/helper.php

Methods summary

`public static JComponentRecord`	# `getComponent( string $option, boolean $strict = false )` Get the component information. Get the component information. Parameters `$option` `string` - $option The component option. `$strict` `boolean` - $strict If set and the component does not exist, the enabled attribute will be set to false. Returns `JComponentRecord` - An object with the information for the component. Since 1.5
`public static boolean`	# `isEnabled( string $option )` Checks if the component is enabled Checks if the component is enabled Parameters `$option` `string` - $option The component option. Returns `boolean` Since 1.5
`public static integer`	# `isInstalled( string $option )` Checks if a component is installed Checks if a component is installed Parameters `$option` `string` - $option The component option. Returns `integer` Since 3.4
`public static Joomla\Registry\Registry`	# `getParams( string $option, boolean $strict = false )` Gets the parameter object for the component Gets the parameter object for the component Parameters `$option` `string` - $option The option for the component. `$strict` `boolean` - $strict If set and the component does not exist, false will be returned Returns `Joomla\Registry\Registry` - A Registry object. Since 1.5 See `Joomla\Registry\Registry`
`public static string`	# `filterText( string $text )` Applies the global text filters to arbitrary text as per settings for current user groups Applies the global text filters to arbitrary text as per settings for current user groups Parameters `$text` `string` - $text The string to filter Returns `string` - The filtered string Since 2.5
`public static string`	# `renderComponent( string $option, array $params = array() )` Render the component. Render the component. Parameters `$option` `string` - $option The component option. `$params` `array` - $params The component parameters Returns `string` Throws `JComponentExceptionMissing` Since 1.5
`protected static string`	# `executeComponent( string $path )` Execute the component. Execute the component. Parameters `$path` `string` - $path The component path. Returns `string` - The component output Since 1.7
`protected static boolean`	# `_load( string $option )` Load the installed components into the components property. Load the installed components into the components property. Deprecated 4.0 Use JComponentHelper::load() instead Parameters `$option` `string` - $option The element value for the extension Returns `boolean` - True on success Since 1.5
`protected static boolean`	# `load( string $option )` Load the installed components into the components property. Load the installed components into the components property. Parameters `$option` `string` - $option The element value for the extension Returns `boolean` - True on success Since 3.2 Note As of 4.0 this method will be restructured to only load the data into memory
`public static JComponentRecord[]`	# `getComponents( )` Get installed components Get installed components Returns `JComponentRecord[]` - The components property Since 3.6.3

Magic methods summary

Properties summary

`protected static JComponentRecord[]`	`$components`	# The component list cache The component list cache Since 1.6

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JComponentHelper

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

See

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

Parameters

Returns

Since

Note

Returns

Since

Magic methods summary

Properties summary

Since