Plugins - advanced/en - Revision history

FuzzyBot: Updating to match new version of source page

2025-08-12T14:30:17Z

Updating to match new version of source page

@@ Line 10: / Line 10: @@
 Plugins must implement the [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/iPlugin.php iPlugin] interface. We recommend extending your plugin class from the [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/PluginBase.php PluginBase] class.
-Plugins are developed around an [https://manual.limesurvey.org/Plugin_events event] mechanism.
+Plugins are developed around an [[Plugin_events|event]] mechanism.
 == Plugin settings ==
@@ Line 289: / Line 289: @@
    $ tail -f tmp/runtime/plugin.log | grep <your plugin name>
 More info about configuring logging in Yii 1: [[Optional_settings#Logging_settings]].

C schmitz: Text replacement - "http://manual.limesurvey.org" to "https://manual.limesurvey.org"

2024-10-15T08:17:20Z

Text replacement - "http://manual.limesurvey.org" to "https://manual.limesurvey.org"

← Older revision		Revision as of 10:17, 15 October 2024
Line 10:		Line 10:
	Plugins must implement the [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/iPlugin.php iPlugin] interface. We recommend extending your plugin class from the [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/PluginBase.php PluginBase] class.		Plugins must implement the [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/iPlugin.php iPlugin] interface. We recommend extending your plugin class from the [https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/PluginBase.php PluginBase] class.

	Plugins are developed around an [~~http~~://manual.limesurvey.org/Plugin_events event] mechanism.		Plugins are developed around an [https://manual.limesurvey.org/Plugin_events event] mechanism.

	== Plugin settings ==		== Plugin settings ==

FuzzyBot: Updating to match new version of source page

2024-04-02T14:59:06Z

Updating to match new version of source page

@@ Line 74: / Line 74: @@
 <syntaxhighlight lang="php">
 $mySetting = $this->get('mySetting', null, null, 10);  // 10 is default
 </syntaxhighlight>
@@ Line 387: / Line 441: @@
 * [[Authentication plugins]]
 * [[Audit log]]
 * [[CintLink]]
 * [[Available third party plugins]]

FuzzyBot: Updating to match new version of source page

2022-10-08T15:38:57Z

Updating to match new version of source page

@@ Line 39: / Line 39: @@
 * int (integer number)
 * string (alphanumeric)
 * html
 * relevance
 * info
 Besides type a number of other keys are available:
@@ Line 55: / Line 58: @@
 * controlOptions : htmlOptions of the wrapper of label and input
-You can find a plugin example using all actual settings at [https://framagit.org/Shnoulle/exampleSettings exampleSettings]
+You can find a plugin example using all actual settings at [https://gitlab.com/SondagesPro/SampleAndDemo/exampleSettings exampleSettings]
 === Read and write plugin settings ===
@@ Line 86: / Line 89: @@
 New functions can be added to the API object upon request.
 == Localization {{NewIn|v=3}} ==

FuzzyBot: Updating to match new version of source page

2022-06-24T13:38:17Z

Updating to match new version of source page

← Older revision		Revision as of 15:38, 24 June 2022
Line 37:		Line 37:

	* logo		* logo
	* string		* int (integer number)
			* string (alphanumeric)
	* html		* html
	* choice		* choice

FuzzyBot: Updating to match new version of source page

2022-03-09T17:20:00Z

Updating to match new version of source page

← Older revision		Revision as of 19:20, 9 March 2022
Line 113:		Line 113:

	to do plugin specific translation in your view.		to do plugin specific translation in your view.

			You can use the [https://github.com/LimeSurvey/LimeSurvey/blob/master/locale/_template/limesurvey.pot limesurvey.pot] file as an example of how a pot file can look like. This is imported into your translation tool.

			=== Tools ===

			One open-source tool to edit po- and mo-files is [https://poedit.net/ Poedit].

	== Logging {{NewIn\|v=3}} ==		== Logging {{NewIn\|v=3}} ==

C schmitz: Text replacement - " enclose="div"" to ""

2022-02-16T13:03:26Z

Text replacement - " enclose="div"" to ""

← Older revision		Revision as of 15:03, 16 February 2022
Line 18:		Line 18:
	The example plugin exposes just 1 configurable setting, the message it'll show.		The example plugin exposes just 1 configurable setting, the message it'll show.

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">
	protected $settings = array(		protected $settings = array(
	'logo' => array(		'logo' => array(

FuzzyBot: Updating to match new version of source page

2021-07-09T13:28:30Z

Updating to match new version of source page

← Older revision		Revision as of 15:28, 9 July 2021
Line 265:		Line 265:

	The top <code>type</code> tag in config.xml ('plugin', 'theme', ...) will control which extension updater are used for this extension. The system is not fully customizable yet, since you also need to add a custom ExtensionInstaller, menu items, etc. But in theory, and maybe in the future, it should be possible to add a new type of extension this way.		The top <code>type</code> tag in config.xml ('plugin', 'theme', ...) will control which extension updater are used for this extension. The system is not fully customizable yet, since you also need to add a custom ExtensionInstaller, menu items, etc. But in theory, and maybe in the future, it should be possible to add a new type of extension this way.

			== Extension installer ==

			The extension installer library consists of two abstract classes:

			* ExtensionInstaller
			* FileFetcher

			The ExtensionInstaller is subclassed for each extension type, like PluginInstaller, QuestionThemeInstaller, etc.

			The FileFetcher is subclassed for each different way to fetch files. Currently, only uploaded zip files are supported, but in the future, there could be a Github or LimeStore fetcher too.

			[[File: extensioninstalleruml.png]]

	== Special plugins ==		== Special plugins ==

FuzzyBot: Updating to match new version of source page

2021-06-05T15:13:07Z

Updating to match new version of source page

← Older revision		Revision as of 17:13, 5 June 2021
Line 130:		Line 130:
	The log file can be found in folder		The log file can be found in folder

	~~<syntaxhighlight lang="bash>~~		<limesurvey root folder>/tmp/runtime/plugin.log
	<limesurvey root folder>/tmp/runtime/plugin.log
	~~</syntaxhighlight>~~

	Your plugin name is automatically used as category. A nice way to see only the errors from your plugin is using grep (on Linux):		Your plugin name is automatically used as category. A nice way to see only the errors from your plugin is using grep (on Linux):

	~~<syntaxhighlight lang="bash>~~		$ tail -f tmp/runtime/plugin.log \| grep <your plugin name>
	$ ~~tailf~~ tmp/runtime/plugin.log \| grep <your plugin name>
	~~</syntaxhighlight~~>

	More info about configuring logging in Yii 1: [[Optional_settings#Logging_settings]].		More info about configuring logging in Yii 1: [[Optional_settings#Logging_settings]].
Line 212:		Line 208:
	Program flow when Yii starts:		Program flow when Yii starts:

	<~~syntaxhighlight lang="txt"~~>		<pre>
	Yii init		Yii init
	VersionFetcherServiceLocator->init()		VersionFetcherServiceLocator->init()
Line 219:		Line 215:
	Add PluginUpdater		Add PluginUpdater
	TODO: Add an updater for each extension type (theme, question template, ...)		TODO: Add an updater for each extension type (theme, question template, ...)
	</~~syntaxhighlight~~>		</pre>

	Program flow when running the UpdaterCheck plugin:		Program flow when running the UpdaterCheck plugin:

	<~~syntaxhighlight lang="txt"~~>		<pre>
	Get all updaters from ExtensionUpdaterServiceLocator		Get all updaters from ExtensionUpdaterServiceLocator
	Loop each updater		Loop each updater
Line 229:		Line 225:
	For each version fetcher, contact remote source and get version information		For each version fetcher, contact remote source and get version information
	Compose all versions into a notification		Compose all versions into a notification
	</~~syntaxhighlight~~>		</pre>

	The [https://github.com/LimeSurvey/LimeSurvey/blob/develop/application/core/plugins/UpdateCheck/UpdateCheck.php#L130 checkAll] method in the UpdateCheck plugin provides an example of how to query all extensions for new versions.		The [https://github.com/LimeSurvey/LimeSurvey/blob/develop/application/core/plugins/UpdateCheck/UpdateCheck.php#L130 checkAll] method in the UpdateCheck plugin provides an example of how to query all extensions for new versions.

FuzzyBot: Updating to match new version of source page

2020-05-19T14:40:13Z

Updating to match new version of source page

← Older revision		Revision as of 16:40, 19 May 2020
Line 130:		Line 130:
	The log file can be found in folder		The log file can be found in folder

	<limesurvey root folder>/tmp/runtime/plugin.log		<syntaxhighlight lang="bash>
			<limesurvey root folder>/tmp/runtime/plugin.log
			</syntaxhighlight>

	Your plugin name is automatically used as category. A nice way to see only the errors from your plugin is using grep (on Linux):		Your plugin name is automatically used as category. A nice way to see only the errors from your plugin is using grep (on Linux):

	$ tailf tmp/runtime/plugin.log \| grep <your plugin name>		<syntaxhighlight lang="bash>
			$ tailf tmp/runtime/plugin.log \| grep <your plugin name>
			</syntaxhighlight>

			More info about configuring logging in Yii 1: [[Optional_settings#Logging_settings]].

	== Extension updates {{NewIn\|v=4}} ==		== Extension updates {{NewIn\|v=4}} ==