Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JModuleHelper

Liste de tous les membres

Fonctions membres publiques statiques

static & getModule ($name, $title=null)
static & getModules ($position)
static isEnabled ($module)
static renderModule ($module, $attribs=array())
static getLayoutPath ($module, $layout= 'default')
static moduleCache ($module, $moduleparams, $cacheparams)

Fonctions membres protégées statiques

static & _load ()

Documentation des fonctions membres

static& JModuleHelper::_load ( )
staticprotected

Load published modules.

Renvoie:
array
Depuis:
11.1

Références $app, $cacheid, $clientId, $date, $db, $file, $i, $lang, $modules, $n, $query, $user, JFactory\getApplication(), JFactory\getCache(), JFactory\getDate(), JFactory\getDbo(), JRequest\getInt(), JFactory\getLanguage(), JFactory\getUser(), null, JError\raiseWarning(), et JText\sprintf().

Référencé par getModule(), et getModules().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JModuleHelper::getLayoutPath (   $module,
  $layout = 'default' 
)
static

Get the path to a layout for a module

Paramètres:
string$moduleThe name of the module
string$layoutThe name of the module layout. If alternative layout, in the form template:filename.
Renvoie:
string The path to the module layout
Depuis:
11.1

Références $layout, $template, elseif, JFactory\getApplication(), JPATH_BASE, et JPATH_THEMES.

+ Voici le graphe d'appel pour cette fonction :

static& JModuleHelper::getModule (   $name,
  $title = null 
)
static

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')

Paramètres:
string$nameThe name of the module
string$titleThe title of the module, optional
Renvoie:
object The Module object
Depuis:
11.1

Références $i, $modules, $name, $title, $total, _load(), null, et title.

Référencé par plgContentLoadmodule\_loadmod(), getModules(), isEnabled(), et JDocumentRendererModule\render().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static& JModuleHelper::getModules (   $position)
static

Get modules by position

Paramètres:
string$positionThe position of the module
Renvoie:
array An array of module objects
Depuis:
11.1

Références $i, $modules, $total, _load(), JRequest\getBool(), getModule(), et JComponentHelper\getParams().

Référencé par plgContentLoadmodule\_load(), JDocumentHTML\countModules(), CpanelViewCpanel\display(), modChrome_beezTabs(), et JDocumentRendererModules\render().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JModuleHelper::isEnabled (   $module)
static

Checks if a module is enabled

Paramètres:
string$moduleThe module name
Renvoie:
boolean
Depuis:
11.1

Références getModule().

+ Voici le graphe d'appel pour cette fonction :

static JModuleHelper::moduleCache (   $module,
  $moduleparams,
  $cacheparams 
)
static

Module cache helper

Caching modes: To be set in XML: 'static' One cache file for all pages with the same module parameters 'oldstatic' 1.5 definition of module caching, one cache file for all pages with the same module id and user aid, 'itemid' Changes on itemid change, to be called from inside the module: 'safeuri' Id created from $cacheparams->modeparams array, 'id' Module sets own cache id's

Paramètres:
object$moduleModule object
object$moduleparamsModule parameters
object$cacheparamsModule cache parameters - id or url parameters, depending on the module cache mode
Renvoie:
string
Depuis:
11.1

JFilterInput::clean()

Références $cacheparams, $key, $uri, $user, JRequest\_cleanVar(), JRequest\get(), JFactory\getCache(), JFactory\getConfig(), JFactory\getUser(), JRequest\getVar(), et null.

+ Voici le graphe d'appel pour cette fonction :

static JModuleHelper::renderModule (   $module,
  $attribs = array() 
)
static

Render the module.

Paramètres:
object$moduleA module object.
array$attribsAn array of attributes for the module (probably from the XML).
Renvoie:
string The HTML content of the module output.
Depuis:
11.1

Références $app, $attribs, $lang, $params, $path, $style, JFactory\getApplication(), JRequest\getBool(), JProfiler\getInstance(), JFactory\getLanguage(), JComponentHelper\getParams(), JPATH_BASE, JPATH_THEMES, et null.

Référencé par JDocumentRendererModule\render().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :


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