Référence de la classe PlgContentLoadmodule

Graphe d'héritage de PlgContentLoadmodule:

Fonctions membres publiques
	onContentPrepare ($context, &$article, &$params, $page=0)

Fonctions membres protégées
	_load ($position, $style='none')
	_loadmod ($module, $title, $style='none')
	_loadid ($id)

Attributs protégés statiques
static	$modules = array()
static	$mods = array()

Description détaillée

Plugin to enable loading modules into content (e.g. articles) This uses the {loadmodule} syntax

Depuis

1.5

Documentation des fonctions membres

_load()

_load (   $position,   $style = 'none'  )

protected

Loads and renders the module

Paramètres

string	$position	The position assigned to the module
string	$style	The style assigned to the module

Renvoie

mixed

Depuis

1.6

Références $document, $module, $modules, $params, $position, $renderer, $style, et getDocument.

_loadid()

_loadid (   $id )

protected

Loads and renders the module

Paramètres

string

$id

The id of the module

Renvoie

mixed

Depuis

3.9.0

Références $document, $id, $modules, $params, $renderer, et getDocument.

_loadmod()

_loadmod (   $module,   $title,   $style = 'none'  )

protected

This is always going to get the first instance of the module type unless there is a title.

Paramètres

string	$module	The module title
string	$title	The title of the module
string	$style	The style of the module

Renvoie

mixed

Depuis

1.6

Références $document, $mod, $module, $name, $params, $renderer, $style, $title, et getDocument.

onContentPrepare()

onContentPrepare	(		$context,
		&	$article,
		&	$params,
			$page = 0
	)

Plugin that loads module positions within content

Paramètres

string	$context	The context of the content being passed to the plugin.
object	&$article	The article object. Note $article->text is also available
mixed	&$params	The article params
integer	$page	The 'page' number

Renvoie

mixed true if there is an error. Void otherwise.

Depuis

1.6

Références $article, $context, $id, $module, $name, $output, $position, $start, $style, et null.

Documentation des champs

$mods

$mods = array()

staticprotected

$modules

$modules = array()

staticprotected

---

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

• loadmodule.php