Class JComponentHelper

Description

Component helper class

  • since: 11.1

Located in /libraries/joomla/application/component/helper.php (line 19)


	
			
Variable Summary
static array $components
Method Summary
static string executeComponent (string $path)
static string filterText (string $text)
static object An getComponent (string $option, [boolean $strict = false])
static JRegistry getParams (string $option, [boolean $strict = false])
static boolean isEnabled (string $option, [boolean $strict = false])
static object renderComponent (string $option, [array $params = array()])
static boolean _load (string $option)
Variables
static array $components = array() (line 27)

The component list cache

  • since: 11.1
  • access: protected
Methods
static method executeComponent (line 380)

Execute the component.

  • return: The component output
  • since: 11.3
  • access: protected
static string executeComponent (string $path)
  • string $path: The component path.
static method filterText (line 106)

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

  • return: The filtered string
  • since: 11.4
  • access: public
static string filterText (string $text)
  • string $text: The string to filter
static method getComponent (line 39)

Get the component information.

  • return: object with the information for the component.
  • since: 11.1
  • access: public
static object An getComponent (string $option, [boolean $strict = false])
  • string $option: The component option.
  • boolean $strict: If set and the component does not exist, the enabled attribute will be set to false.
static method getParams (line 90)

Gets the parameter object for the component

  • return: A JRegistry object.
  • see: JRegistry
  • since: 11.1
  • access: public
static JRegistry getParams (string $option, [boolean $strict = false])
  • string $option: The option for the component.
  • boolean $strict: If set and the component does not exist, false will be returned
static method isEnabled (line 72)

Checks if the component is enabled

  • since: 11.1
  • access: public
static boolean isEnabled (string $option, [boolean $strict = false])
  • string $option: The component option.
  • boolean $strict: If set and the component does not exist, false will be returned.
static method renderComponent (line 288)

Render the component.

  • since: 11.1
  • access: public
static object renderComponent (string $option, [array $params = array()])
  • string $option: The component option.
  • array $params: The component parameters
static method _load (line 398)

Load the installed components into the components property.

  • return: True on success
  • since: 11.1
  • access: protected
static boolean _load (string $option)
  • string $option: The element value for the extension

Documentation generated on Mon, 25 Jun 2012 13:55:28 -0500 by phpDocumentor 1.4.4