[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_modules/src/Helper/ -> ModulesHelper.php (summary)

(no description)

Copyright: (C) 2017 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 312 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  getStateOptions()
  getClientOptions()
  getPositions()
  getTemplates()
  getModules()
  getAssignmentOptions()
  getTranslatedModulePosition()
  isTranslatedText()
  createOption()
  createOptionGroup()

Functions
Functions that are not part of a class:

getStateOptions()   X-Ref
Get a list of filter options for the state of a module.

return: array  An array of \JHtmlOption elements.

getClientOptions()   X-Ref
Get a list of filter options for the application clients.

return: array  An array of \JHtmlOption elements.

getPositions($clientId, $editPositions = false)   X-Ref
Get a list of modules positions

param: integer  $clientId       Client ID
param: boolean  $editPositions  Allow to edit the positions
return: array  A list of positions

getTemplates($clientId = 0, $state = '', $template = '')   X-Ref
Return a list of templates

param: integer  $clientId  Client ID
param: string   $state     State
param: string   $template  Template name
return: array  List of templates

getModules($clientId)   X-Ref
Get a list of the unique modules installed in the client application.

param: int  $clientId  The client id.
return: array  Array of unique modules

getAssignmentOptions($clientId)   X-Ref
Get a list of the assignment options for modules to menus.

param: int  $clientId  The client id.
return: array

getTranslatedModulePosition($clientId, $template, $position)   X-Ref
Return a translated module position name

param: integer  $clientId  Application client id 0: site | 1: admin
param: string   $template  Template name
param: string   $position  Position name
return: string  Return a translated position name

isTranslatedText($langKey, $text)   X-Ref
Check if the string was translated

param: string  $langKey  Language file text key
param: string  $text     The "translated" text to be checked
return: boolean  Return true for translated text

createOption($value = '', $text = '')   X-Ref
Create and return a new Option

param: string  $value  The option value [optional]
param: string  $text   The option text [optional]
return: object  The option as an object (\stdClass instance)

createOptionGroup($label = '', $options = array()   X-Ref
Create and return a new Option Group

param: string  $label    Value and label for group [optional]
param: array   $options  Array of options to insert into group [optional]
return: array  Return the new group as an array



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer