Class ModulesHelper

Description

Modules component helper.

  • abstract:
  • since: 1.6

Located in /administrator/components/com_modules/helpers/modules.php (line 17)


	
			
Method Summary
static void addSubmenu (string $vName)
static JObject getActions ()
static array getAssignmentOptions (int $clientId)
static array getClientOptions ()
static array getModules (int $clientId)
static void getPositions ( $clientId)
static array getStateOptions ()
static void getTemplates ([ $clientId = 0], [ $state = ''], [ $template = ''])
Methods
static method addSubmenu (line 24)

Configure the Linkbar.

  • access: public
static void addSubmenu (string $vName)
  • string $vName: The name of the active view.
static method getActions (line 34)

Gets a list of the actions that can be performed.

  • access: public
static JObject getActions ()
static method getAssignmentOptions (line 183)

Get a list of the assignment options for modules to menus.

  • access: public
static array getAssignmentOptions (int $clientId)
  • int $clientId: The client id.
static method getClientOptions (line 68)

Get a list of filter options for the application clients.

  • return: An array of JHtmlOption elements.
  • access: public
static array getClientOptions ()
static method getModules (line 146)

Get a list of the unique modules installed in the client application.

  • access: public
static array getModules (int $clientId)
  • int $clientId: The client id.
static method getPositions (line 77)
static void getPositions ( $clientId)
  • $clientId
static method getStateOptions (line 53)

Get a list of filter options for the state of a module.

  • return: An array of JHtmlOption elements.
  • access: public
static array getStateOptions ()
static method getTemplates (line 115)
  • access: public
static void getTemplates ([ $clientId = 0], [ $state = ''], [ $template = ''])
  • $clientId
  • $state
  • $template

Documentation generated on Mon, 25 Jun 2012 13:57:36 -0500 by phpDocumentor 1.4.4