Example

Extends \PluginBase

NB: Deleting this class will break plugin API, since plugins then would have to extend PluginBase in the namespace instead of this class. This is especially a problem for plugins that should work on both 2.73 and 3.x, so please don't delete this class.

package

Default

Methods

Constructor for the plugin

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

Add proper type hint in 3.0

Arguments

$manager

\LimeSurvey\PluginManager\PluginManager

The plugin manager instantiating the object

$id

integer

The id for storage

afterAdminMenuLoaded

afterAdminMenuLoaded() 

This event is fired by the administration panel to gather extra settings available for a survey.

beforeSurveySettings() 

The plugin should return setting meta data.

Check if config field active is 1. If yes, activate the plugin.

checkActive(\Plugin $pluginModel) : void
inherited

This is the 'active-by-default' feature.

Arguments

$pluginModel

\Plugin

Returns true if config file has a higher version than database.

configIsNewVersion() : boolean
inherited

Assumes $this->config is set.

Response

boolean

This function retrieves plugin data. Do not cache this data; the plugin storage engine will handling caching. After the first call to this function, subsequent calls will only consist of a few function calls and array lookups.

get(string $key = null, string $model = null, integer $id = null, mixed $default = null) : boolean
inherited

Arguments

$key

string

$model

string

$id

integer

$default

mixed

The default value to use when not was set

Response

boolean

Return the description for this plugin

getDescription() 
inherited static

To find the plugin locale file, we need late runtime result of __DIR__.

getDir() : string
inherited

Get the current event this plugin is responding to

getEvent() : \LimeSurvey\PluginManager\PluginEvent
inherited

Returns the id of the plugin

getId() : integer
inherited

Used by storage model to find settings specific to this plugin

Response

integer

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

getName() : string
inherited 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
inherited

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 the plugin storage and takes care of instantiating it

getStore() : \LimeSurvey\PluginManager\iPluginStorage
inherited

Translation for plugin

gT(string $sToTranslate, string $sEscapeMode = 'html', string $sLanguage = null) : string
inherited

Arguments

$sToTranslate

string

The message that are being translated

$sEscapeMode

string

$sLanguage

string

Response

string

helloWorld

helloWorld() 

Call the Yii::log function to log into tmp/runtime/plugin.log The plugin name is the category.

log(string $message, string $level = \CLogger::LEVEL_TRACE) : void
inherited

Arguments

$message

string

$level

string

From CLogger, defaults to CLogger::LEVEL_TRACE

newSurveySettings

newSurveySettings() 

Publishes plugin assets.

publish( $fileName) : string
inherited

Arguments

$fileName

Response

string

Read JSON config file and store it in $this->config Assumes config file is config.json and in plugin root folder.

readConfigFile() : void
inherited

registerSetting

registerSetting(string $name, array $options = array('type' => 'string')) 
inherited

Arguments

$name

string

Name of the setting. The type of the setting is either a basic type or choice. The choice type is either a single or a multiple choice setting.

$options

array

Contains parameters for the setting. The 'type' key contains the parameter type. The type is one of: string, int, float, choice. Supported keys per type: String: max-length(int), min-length(int), regex(string). Int: max(int), min(int). Float: max(float), min(float). Choice: choices(array containing values as keys and names as values), multiple(bool) Note that the values for choice will be translated.

Look for views in plugin views/ folder and render it

renderPartial(string $viewfile, array $data, boolean $return = false, boolean $processOutput = false) : \LimeSurvey\PluginManager\string;
inherited

Arguments

$viewfile

string

Filename of view in views/ folder

$data

array

$return

boolean

$processOutput

boolean

Response

\LimeSurvey\PluginManager\string;

Saves the new version from config into database

saveNewVersion() : void
inherited

Saves the settings for this plugin

saveSettings(\LimeSurvey\PluginManager\type $settings) 
inherited

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

Arguments

$settings

\LimeSurvey\PluginManager\type

This function stores plugin data.

set(string $key, mixed $data, string $model = null, integer $id = null) : boolean
inherited

Arguments

$key

string

$data

mixed

$model

string

$id

integer

Response

boolean

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
inherited

We need a component for each plugin to load correct locale file.

setLocaleComponent() : void
inherited

Show an error message about malformed config.json file.

showConfigErrorNotification() : void
inherited

This function subscribes the plugin to receive an event.

subscribe(string $event, string $function = null) 
inherited

Arguments

$event

string

$function

string

This function unsubscribes the plugin from an event.

unsubscribe(string $event) 
inherited

Arguments

$event

string

Properties

storage

storage : 
inherited

Type(s)

description

description : 
inherited static

Type(s)

settings

settings : 
inherited

Type(s)

api

api : \LimeSurvey\PluginManager\LimesurveyApi
inherited

event

event : \LimeSurvey\PluginManager\PluginEvent
inherited

id

id : 
inherited

Type(s)

name

name : 
inherited static

Type(s)

store

store : 
inherited

Type(s)

This holds the pluginmanager that instantiated the plugin

pluginManager : \LimeSurvey\PluginManager\PluginManager
inherited

If plugin has a config.json file, it will be parsed into this variable.

config : \LimeSurvey\PluginManager\StdObject
inherited
var

Type(s)

\LimeSurvey\PluginManager\StdObject