Docs For Class PlgContentLoadmodule

Description

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

since: 1.5

Located in /plugins/content/loadmodule/loadmodule.php (line 20)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgContentLoadmodule

Variable Summary

static mixed $mods

static mixed $modules

Method Summary

mixed onContentPrepare (string $context, object &$article, mixed &$params, [integer $page = 0])

mixed _load (string $position, [string $style = 'none'])

mixed _loadmod (string $module, string $title, [string $style = 'none'])

Variables

static mixed $mods = array() (line 24)

access: protected

static mixed $modules = array() (line 22)

access: protected

Inherited Variables

Inherited from JPlugin

JPlugin::$autoloadLanguage
JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

onContentPrepare (line 38)

Plugin that loads module positions within content

return: true if there is an error. Void otherwise.
since: 1.6
access: public

mixed onContentPrepare (string $context, object &$article, mixed &$params, [integer $page = 0])

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

_load (line 134)

Loads and renders the module

since: 1.6
access: protected

mixed _load (string $position, [string $style = 'none'])

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

_loadmod (line 165)

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

since: 1.6
access: protected

mixed _loadmod (string $module, string $title, [string $style = 'none'])

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

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()