Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JComponentHelper

Description

Component helper class

  • since: 1.5

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

Class JComponentHelper   (Subpackage Application)
Method Summary
Method object A &getComponent (string $name, [ $strict = false], boolean $string)
Method object A &getParams (string $name)
Method boolean isEnabled (string $component, [ $strict = false], boolean $string)
Method void renderComponent ([ $name = null], [ $params = array()])
Methods
getComponent (line 36)

Get the component info

  • return: JComponent object
  • access: public
object A &getComponent (string $name, [ $strict = false], boolean $string)
  • string $name: The component name
  • boolean $string: If set and a component does not exist, the enabled attribue will be set to false
  • $strict
getParams (line 78)

Gets the parameter object for the component

  • return: JParameter object
  • access: public
object A &getParams (string $name)
  • string $name: The component name
isEnabled (line 63)

Checks if the component is enabled

  • access: public
boolean isEnabled (string $component, [ $strict = false], boolean $string)
  • string $component: The component name
  • boolean $string: If set and a component does not exist, false will be returned
  • $strict
renderComponent (line 89)
void renderComponent ([ $name = null], [ $params = array()])
  • $name
  • $params
Support Joomla!