Docs For Class ModulesHelper

ModulesHelper

Description

Modules component helper.

abstract:
since: 1.6

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

Method Summary

static void addSubmenu (string $vName)

static object The createOption ([string $value = ''], [string $text = ''])

static array createOptionGroup ([string $label = ''], [array $options = array()])

static JObject getActions ([integer $moduleId = 0])

static array getAssignmentOptions (int $clientId)

static array getClientOptions ()

static array getModules (int $clientId)

static array getPositions (integer $clientId, [ $editPositions = false])

static array getStateOptions ()

static array getTemplates ([integer $clientId = 0], [string $state = ''], [string $template = ''])

static string getTranslatedModulePosition ( $clientId, string $template, string $position)

static boolean isTranslatedText (string $langKey, string $text)

Methods

static addSubmenu (line 26)

Configure the Linkbar.

access: public

static void addSubmenu (string $vName)

string $vName: The name of the active view.

static createOption (line 302)

Create and return a new Option

return: option as an object (stdClass instance)
since: 3.0
access: public

static object The createOption ([string $value = ''], [string $text = ''])

string $value: The option value [optional]
string $text: The option text [optional]

static createOptionGroup (line 326)

Create and return a new Option Group

return: Return the new group as an array
since: 3.0
access: public

static array createOptionGroup ([string $label = ''], [array $options = array()])

string $label: Value and label for group [optional]
array $options: Array of options to insert into group [optional]

static getActions (line 38)

Gets a list of the actions that can be performed.

access: public

static JObject getActions ([integer $moduleId = 0])

integer $moduleId: The module ID.

static getAssignmentOptions (line 219)

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

access: public

static array getAssignmentOptions (int $clientId)

int $clientId: The client id.

static getClientOptions (line 84)

Get a list of filter options for the application clients.

return: An array of JHtmlOption elements.
access: public

static array getClientOptions ()

static getModules (line 183)

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

return: Array of unique modules
access: public

static array getModules (int $clientId)

int $clientId: The client id.

static getPositions (line 100)

Get a list of modules positions

return: A list of positions
access: public

static array getPositions (integer $clientId, [ $editPositions = false])

integer $clientId: Client ID
$editPositions

static getStateOptions (line 69)

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

return: An array of JHtmlOption elements.
access: public

static array getStateOptions ()

static getTemplates (line 148)

Return a list of templates

return: List of templates
access: public

static array getTemplates ([integer $clientId = 0], [string $state = ''], [string $template = ''])

integer $clientId: Client ID
string $state: State
string $template: Template name

static getTranslatedModulePosition (line 244)

Return a translated module position name

return: Return a translated position name
since: 3.0
access: public

static string getTranslatedModulePosition ( $clientId, string $template, string $position)

string $template: Template name
string $position: Position name
$clientId

static isTranslatedText (line 287)

Check if the string was translated

return: Return true for translated text
since: 3.0
access: public

static boolean isTranslatedText (string $langKey, string $text)

string $langKey: Language file text key
string $text: The "translated" text to be checked

Documentation generated on Tue, 19 Nov 2013 15:08:53 +0100 by phpDocumentor 1.4.3