Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe ModulesHelper

Fonctions membres publiques statiques

static addSubmenu ($vName)
 
static getActions ($moduleId=0)
 
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

◆ addSubmenu()

static addSubmenu (   $vName)
static

Configure the Linkbar.

Paramètres
string$vNameThe name of the active view.
Renvoie
void

Référencé par ModulesController\display().

◆ 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 (stdClass instance)
Depuis
3.0

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

Référencé par JHtmlModules\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 JHtmlModules\positions().

◆ getActions()

static getActions (   $moduleId = 0)
static

Gets a list of the actions that can be performed.

Paramètres
integer$moduleIdThe module ID.
Renvoie
JObject
Obsolète:
3.2 Use JHelperContent::getActions() instead

◆ 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, et $options.

◆ getClientOptions()

static getClientOptions ( )
static

Get a list of filter options for the application clients.

Renvoie
array An array of JHtmlOption elements.

Références $options.

◆ 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, JPATH_ADMINISTRATOR, JPATH_SITE, null, et ArrayHelper\sortObjects().

Référencé par JFormFieldModulesModule\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, et JError\raiseWarning().

Référencé par JFormFieldModulesPosition\getOptions(), et JHtmlModules\positions().

◆ getStateOptions()

static getStateOptions ( )
static

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

Renvoie
array An array of JHtmlOption elements.

Références $options.

◆ 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, et $template.

Référencé par ModulesModelPositions\getItems(), JHtmlModules\positions(), et JHtmlModules\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, JPATH_ADMINISTRATOR, JPATH_SITE, et null.

Référencé par JHtmlModules\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 :