Installed Plugins

This page presents an automatically compiled comprehensive list of plugins installed in the ElektronIQ-wiki.

Syntax plugins

Action plugins

Renderer plugins

Admin plugins

Helper methods

auskommentiert:

~~INFO:helperplugins~~

Führt zu diesem Fehler:

Error: Call to undefined method helper_plugin_diffpreview_changes::getInfo()

Helper methods

discussion plugin

Provides discussion funtionality for wiki pages

$discussion = plugin_load('helper', 'discussion');

$discussion->th()

Descriptionreturns the header of the comments column for pagelist
Return valueheaderstring

$discussion->td()

Descriptionreturns the link to the discussion section with number of comments
Parametersidstring
number of comments (optional)integer
Return valuelinkstring

$discussion->getThreads()

Descriptionreturns pages with discussion sections, sorted by recent comments
Parametersnamespacestring
number (optional)integer
Return valuepagesarray

$discussion->getComments()

Descriptionreturns recently added or edited comments individually
Parametersnamespacestring
number (optional)integer
Return valuepagesarray

$discussion->isDiscussionModerator()

Descriptioncheck if current user is member of moderator groups
Return valueisModeratorboolean

include plugin

Functions to include another page in a wiki page

$include = plugin_load('helper', 'include');

$include->get_flags()

Descriptionoverrides standard values for showfooter and firstseconly settings
Parametersflagsarray

Pagelist Plugin

Lists pages in a nice formatted way

$pagelist = plugin_load('helper', 'pagelist');

$pagelist->addColumn()

Description(optional) adds an extra column for plugin data
Parametersplugin namestring
column keystring

$pagelist->modifyColumn()

Description(optional) override value of an existing column, value equal to false disables column
Parameterscolumn keystring
valueint|bool

$pagelist->setHeader()

Description(optional) Provide header data, if not given default values or [plugin]->th() is used
Parameterscolumn keystring
valueint|bool

$pagelist->setFlags()

Description(optional) overrides default flags, or en/disable existing columns
Parametersflagsarray
Return valuesuccessboolean

$pagelist->startList()

Description(required) prepares the table header for the page list

$pagelist->addPage()

Description(required) adds a page to the list
Parameterspage attributes, 'id' required, others optionalarray

$pagelist->finishList()

Description(required) returns the XHTML output
Return valuexhtmlstring

Tag Plugin

tag wiki pages

$tag = plugin_load('helper', 'tag');

$tag->overrideSortFlags()

Descriptiontakes an array of sortflags and overrides predefined value
Parametersnamestring

$tag->th()

Descriptionreturns the header for the tags column for pagelist
Return valueheaderstring

$tag->td()

Descriptionreturns the tag links of a given page
Parametersidstring
Return valuelinksstring

$tag->tagLinks()

Descriptiongenerates tag links for given words
Parameterstagsarray
Return valuelinksstring

$tag->getTopic()

Descriptionreturns a list of pages tagged with the given keyword
Parametersnamespace (optional)string
number (not used)integer
tag (required)string
Return valuepagesarray

$tag->tagRefine()

Descriptionrefines an array of pages with tags
Parameterspages to refinearray
refinement tagsstring
Return valuepagesarray

$tag->tagOccurrences()

Descriptionreturns a list of tags with their number of occurrences
Parameterslist of tags to get the occurrences forarray
namespaces to which the search shall be restrictedarray
if all tags shall be returned (then the first parameter is ignored)boolean
if the namespaces shall be searched recursivelyboolean
Return valuetagsarray