\plugin

Defines the base functions required for a plugin. A plugin is a container holding one or several modules and records required to accomplish a specific task or adding a specific set of features to MindFlow.

Summary

Methods

Constants

setup()
getName()
getDesc()
getPath()
getKey()
getVersion()
getDependencies()
init()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setup()

setup()

Must create all plugin related tables and insert required default data

getName()

getName() : string

Must return the name of the plugin

Returns

string —

the plugin name

getDesc()

getDesc() : string

Must return an explanation of the purpose of the plugin

Returns

string —

the description

getPath()

getPath() : string

Must return the plugin path relative to Mindflow root (such as "/mf/plugins/my_plugin")

Returns

string —

the plugin path

getKey()

getKey() : string

Must return the plugin key, which is also the plugin directory name.

We recommend avoiding spaces and substitute underscores.

Returns

string —

the plugin key

getVersion()

getVersion() : string

Must return the version number of the plugin

Returns

string —

the version number

getDependencies()

getDependencies() : array

Must return the list of plugins keys this plugin relies on

Returns

array —

of strings featuring valid plugin keys

init()

init()

Must initialize all the objects required for the plugin to run.

The function will likely make use of the following helpers : $mf->pluginManager->addRecord() add a database record object $mf->pluginManager->loadModule() add frontend / backend / authentification module mfUserGroup::defineUserRight() add a user right restriction check