Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ModulesHelper
+ Graphe d'héritage de ModulesHelper:

Fonctions membres publiques statiques

static getStateOptions ()
 
static getClientOptions ()
 
static getPositions ($clientId, $editPositions=false)
 
static getTemplates ($clientId=0, $state='', $template='')
 
static getModules ($clientId)
 
static getAssignmentOptions ($clientId)
 
static getTranslatedModulePosition ($clientId, $template, $position)
 
static isTranslatedText ($langKey, $text)
 
static createOption ($value='', $text='')
 
static createOptionGroup ($label='', $options=array())
 

Description détaillée

Modules component helper.

Depuis
1.6

Documentation des fonctions membres

◆ createOption()

static createOption (   $value = '',
  $text = '' 
)
static

Create and return a new Option

Paramètres
string$valueThe option value [optional]
string$textThe option text [optional]
Renvoie
object The option as an object ( instance)
Depuis
3.0

Références $option, $text, et $value.

Référencé par Modules\positions().

◆ createOptionGroup()

static createOptionGroup (   $label = '',
  $options = array() 
)
static

Create and return a new Option Group

Paramètres
string$labelValue and label for group [optional]
array$optionsArray of options to insert into group [optional]
Renvoie
array Return the new group as an array
Depuis
3.0

Références $label, et $options.

Référencé par Modules\positions().

◆ getAssignmentOptions()

static getAssignmentOptions (   $clientId)
static

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

Paramètres
int$clientIdThe client id.
Renvoie
array

Références $clientId, $options, et HTMLHelper\_().

◆ getClientOptions()

static getClientOptions ( )
static

Get a list of filter options for the application clients.

Renvoie
array An array of elements.

Références $options, Text\_(), et HTMLHelper\_().

◆ getModules()

static getModules (   $clientId)
static

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

Paramètres
int$clientIdThe client id.
Renvoie
array Array of unique modules

Références $clientId, $db, $extension, $i, $lang, $module, $modules, $path, $query, Text\_(), Factory\getDbo(), Factory\getLanguage(), JPATH_ADMINISTRATOR, JPATH_SITE, et ArrayHelper\sortObjects().

Référencé par ModulesModuleField\getOptions().

◆ getPositions()

static getPositions (   $clientId,
  $editPositions = false 
)
static

Get a list of modules positions

Paramètres
integer$clientIdClient ID
boolean$editPositionsAllow to edit the positions
Renvoie
array A list of positions

Références $clientId, $db, $options, $position, $positions, $query, Text\_(), HTMLHelper\_(), elseif, Factory\getApplication(), Factory\getDbo(), et ParameterType\INTEGER.

Référencé par ModulesPositionField\getOptions(), et Modules\positions().

◆ getStateOptions()

static getStateOptions ( )
static

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

Renvoie
array An array of elements.

Références $options, Text\_(), et HTMLHelper\_().

◆ getTemplates()

static getTemplates (   $clientId = 0,
  $state = '',
  $template = '' 
)
static

Return a list of templates

Paramètres
integer$clientIdClient ID
string$stateState
string$templateTemplate name
Renvoie
array List of templates

Références $clientId, $db, $query, $state, $template, Factory\getDbo(), et ParameterType\INTEGER.

Référencé par PositionsModel\getItems(), Modules\positions(), ModuleModel\preprocessForm(), et Modules\templates().

◆ getTranslatedModulePosition()

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

Return a translated module position name

Paramètres
integer$clientIdApplication client id 0: site | 1: admin
string$templateTemplate name
string$positionPosition name
Renvoie
string Return a translated position name
Depuis
3.0

Références $clientId, $lang, $path, $position, $template, $text, Text\_(), Factory\getLanguage(), JPATH_ADMINISTRATOR, JPATH_SITE, et null.

Référencé par Modules\positions().

◆ isTranslatedText()

static isTranslatedText (   $langKey,
  $text 
)
static

Check if the string was translated

Paramètres
string$langKeyLanguage file text key
string$textThe "translated" text to be checked
Renvoie
boolean Return true for translated text
Depuis
3.0

Références $text.


La documentation de cette classe a été générée à partir du fichier suivant :