[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/libraries/joomla/application/component/ -> helper.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 434 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JComponentHelper:: (7 methods):
  getComponent()
  isEnabled()
  getParams()
  filterText()
  renderComponent()
  executeComponent()
  _load()


Class: JComponentHelper  - X-Ref

Component helper class

getComponent($option, $strict = false)   X-Ref
Get the component information.

param: string   $option  The component option.
param: boolean  $strict  If set and the component does not exist, the enabled attribute will be set to false.
return: object   An object with the information for the component.

isEnabled($option, $strict = false)   X-Ref
Checks if the component is enabled

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

getParams($option, $strict = false)   X-Ref
Gets the parameter object for the component

param: string   $option  The option for the component.
param: boolean  $strict  If set and the component does not exist, false will be returned
return: JRegistry  A JRegistry object.

filterText($text)   X-Ref
Applies the global text filters to arbitrary text as per settings for current user groups

param: text  $text  The string to filter
return: string  The filtered string

renderComponent($option, $params = array()   X-Ref
Render the component.

param: string  $option  The component option.
param: array   $params  The component parameters
return: object

executeComponent($path)   X-Ref
Execute the component.

param: string  $path  The component path.
return: string  The component output

_load($option)   X-Ref
Load the installed components into the _components property.

param: string  $option  The element value for the extension
return: boolean  True on success



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1