LimeSurvey API - Master branch
Back to top  

iPlugin

Extends

package

Default

Methods

Should return the description for this plugin Constructor for the plugin

__construct(\LimeSurvey\PluginManager\PluginManager $manager, integer $id)

Arguments

$manager

\LimeSurvey\PluginManager\PluginManager

The plugin manager instantiating the object

$id

integer

The id for storage

Return the description for this plugin

getDescription()
static

Get the current event this plugin is responding to

getEvent() : \LimeSurvey\PluginManager\PluginEvent

Response

\LimeSurvey\PluginManager\PluginEvent

Get the id of this plugin (set by PluginManager on instantiation)

getId() : integer

Response

integer

Gets the name for the plugin, this must be unique.

getName() : string
static

Response

string

Plugin name, max length: 20.

Provides meta data on the plugin settings that are available for this plugin.

getPluginSettings(boolean $getValues = true) : array

This does not include enable / disable; a disabled plugin is never loaded.

Arguments

$getValues

boolean

Set to false to not get the current value for each plugin setting.

Response

array

Returns a reference to the storage interface for the plugin.

getStore() : \LimeSurvey\PluginManager\iPluginStorage

Response

\LimeSurvey\PluginManager\iPluginStorage

Saves the settings for this plugin

saveSettings(array $aSettings)

Assumes an array with valid key/value pairs is passed.

Arguments

$aSettings

array

An array with key/value pairs for all plugin settings

Set the event to the plugin, this method is executed by the PluginManager just before dispatching the event.

setEvent(\LimeSurvey\PluginManager\PluginEvent $event) : \LimeSurvey\PluginManager\PluginBase

Arguments

$event

\LimeSurvey\PluginManager\PluginEvent

Response

\LimeSurvey\PluginManager\PluginBase