Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class ComponentHelper - list of methods

Component helper class
Package: Joomla\CMS\Component
Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Component/ComponentHelper.php
Project: Joomla

Method Summary

public static \Joomla\CMS\Component\ComponentRecord
(mixed $option, mixed $strict = false)

Get the component information.
Parameters
  • string $option The component option.
  • bool $strict If set and the component does not exist, the enabled attribute will be set to false.
Returns
  • \Joomla\CMS\Component\ComponentRecord An object with the information for the component.
Since
  • 1.5
Show source code of this method: getComponent Source Code

public static bool
(mixed $option)

Checks if the component is enabled
Parameters
  • string $option The component option.
Returns
  • bool
Since
  • 1.5
Show source code of this method: isEnabled Source Code

public static int
(mixed $option)

Checks if a component is installed
Parameters
  • string $option The component option.
Returns
  • int
Since
  • 3.4
Show source code of this method: isInstalled Source Code

public static \Joomla\Registry\Registry
(mixed $option, mixed $strict = false)

Gets the parameter object for the component
Parameters
  • string $option The option for the component.
  • bool $strict If set and the component does not exist, false will be returned
Returns
  • \Joomla\Registry\Registry A Registry object.
Since
  • 1.5
-
  • \Joomla\Registry\Registry
Show source code of this method: getParams Source Code

public static string
(mixed $text)

Applies the global text filters to arbitrary text as per settings for current user groups
Parameters
  • string $text The string to filter
Returns
  • string The filtered string
Since
  • 2.5
Show source code of this method: filterText Source Code

public static string
(mixed $option, mixed $params = array())

Render the component.
Parameters
  • string $option The component option.
  • array $params The component parameters
Returns
  • string
Since
  • 1.5
-
  • \Joomla\CMS\Component\Exception\MissingComponentException
Show source code of this method: renderComponent Source Code

protected static bool
()

Load the installed components into the components property.
Returns
  • bool True on success
Since
  • 3.2
Show source code of this method: load Source Code

public static \Joomla\CMS\Component\ComponentRecord[]
()

Get installed components
Returns
  • \Joomla\CMS\Component\ComponentRecord[] The components property
Since
  • 3.6.3
Show source code of this method: getComponents Source Code

public static string
(mixed $object, string $alternativeName)

Returns the component name (eg. com_content) for the given object based on the class name.
Parameters
  • object $object The object controller or model
  • string $alternativeName Mostly the value of getName() from the object
Returns
  • string The name
Since
  • 4.0.0
Show source code of this method: getComponentName Source Code

Properties Summary

protected static \Joomla\CMS\Component\ComponentRecord[]
$components
The component list cache
Since
  • 1.6

Tags Summary

Since
1.5