Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

Class JComponentHelper

Description
Description | Methods (details)

Component helper class

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

Class JComponentHelper   (Subpackage Application)
Method Summary
Description | Methods (details)
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
Description | Methods (details)
getComponent (line 37)

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

Gets the parameter object for the component

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

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 90)
void renderComponent ([ $name = null], [ $params = array()])
  • $name
  • $params
Documentation generated on Tue, 29 Jan 2008 18:47:30 +0000 by phpDocumentor 1.3.1