Make your plugin compatible with LS4 - Revision history

Han at 19:31, 12 March 2021

2021-03-12T19:31:52Z

← Older revision		Revision as of 21:31, 12 March 2021
Line 46:		Line 46:
	<!--T:11-->		<!--T:11-->
	Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.		Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.
	For more information check our development manual on ~~plugin events at~~ [[Plugin_events\|~~Plugin~~ events]]		For more information check our development manual on [[Plugin_events\|plugin events]].

	==Deprecated functions and methods== <!--T:12-->		==Deprecated functions and methods== <!--T:12-->

Han: link changed

2021-03-12T19:31:12Z

link changed

← Older revision		Revision as of 21:31, 12 March 2021
Line 46:		Line 46:
	<!--T:11-->		<!--T:11-->
	Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.		Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.
	For more information check our development manual on plugin events at ~~https://manual.limesurvey.org/~~Plugin_events		For more information check our development manual on plugin events at [[Plugin_events\|Plugin events]]


	==Deprecated functions and methods== <!--T:12-->		==Deprecated functions and methods== <!--T:12-->

Han: link changed

2021-03-12T19:20:48Z

link changed

← Older revision		Revision as of 21:20, 12 March 2021
Line 15:		Line 15:

	<!--T:26-->		<!--T:26-->
	This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development ~~wiki at https://manual.limesurvey.org/~~Plugins_-_advanced#Available_plugins		This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development [[Plugins_-_advanced#Available_plugins\|plugins]]

	<!--T:4-->		<!--T:4-->
Line 22:		Line 22:
	<!--T:5-->		<!--T:5-->
	<center>[[File:config_xml.png]]</center>		<center>[[File:config_xml.png]]</center>


	==The new plugin directory== <!--T:6-->		==The new plugin directory== <!--T:6-->

Han: Marked this version for translation

2021-03-09T10:30:18Z

Marked this version for translation

← Older revision		Revision as of 12:30, 9 March 2021
Line 5:		Line 5:
	=Technical changes= <!--T:1-->		=Technical changes= <!--T:1-->

	==The new XML config file ==<!--T:2-->		==The new XML config file == <!--T:2-->


Line 11:		Line 11:
	Since LimeSurvey 4.0, plugins need a XML config file to be run in the application.		Since LimeSurvey 4.0, plugins need a XML config file to be run in the application.

			<!--T:25-->
	The reason for this is the possibility to store meta-data information such as plugin Author, support email or updaters information.		The reason for this is the possibility to store meta-data information such as plugin Author, support email or updaters information.

			<!--T:26-->
	This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development wiki at https://manual.limesurvey.org/Plugins_-_advanced#Available_plugins		This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development wiki at https://manual.limesurvey.org/Plugins_-_advanced#Available_plugins

Line 22:		Line 24:


	==The new plugin directory==<!--T:6-->		==The new plugin directory== <!--T:6-->

	<!--T:7-->		<!--T:7-->
Line 28:		Line 30:
	For manual uploads, we recommend to upload your files to the new directory to avoid software malfunctioning.		For manual uploads, we recommend to upload your files to the new directory to avoid software malfunctioning.

			<!--T:27-->
	Make sure to change or add the new directory if it is hard-coded in your plugin.		Make sure to change or add the new directory if it is hard-coded in your plugin.

Line 38:		Line 41:


	==The new plugin events==<!--T:10-->		==The new plugin events== <!--T:10-->


Line 47:		Line 50:


	==Deprecated functions and methods==<!--T:12-->		==Deprecated functions and methods== <!--T:12-->


Line 54:		Line 57:
	To fix this problem, you need to enable the debug mode on the config.php file first and then go to the plugin page. Any method that does not exit anymore will be shown on the error page.		To fix this problem, you need to enable the debug mode on the config.php file first and then go to the plugin page. Any method that does not exit anymore will be shown on the error page.

			<!--T:28-->
	Some of the methods are renamed in LS4 or are not used anymore. To be sure that your plugin works for both LS3 & LS4, check the version of LS before calling the method you need.		Some of the methods are renamed in LS4 or are not used anymore. To be sure that your plugin works for both LS3 & LS4, check the version of LS before calling the method you need.

Line 65:		Line 69:


	=Best Practice=<!--T:16-->		=Best Practice= <!--T:16-->



	==Avoid SVG files==<!--T:17-->		==Avoid SVG files== <!--T:17-->


Line 78:		Line 82:


	==Avoid global constants==<!--T:19-->		==Avoid global constants== <!--T:19-->

Galads at 11:32, 25 January 2021

2021-01-25T11:32:26Z

← Older revision		Revision as of 13:32, 25 January 2021
Line 19:		Line 19:

	<!--T:5-->		<!--T:5-->
	<center>[[File:~~createnewsurvey~~.png]]</center>		<center>[[File:config_xml.png]]</center>


Line 35:		Line 35:

	<!--T:9-->		<!--T:9-->
	<center>[[File:~~createnewsurvey~~.png]]</center>		<center>[[File:path_possiblity.png]]</center>


Line 62:		Line 62:

	<!--T:15-->		<!--T:15-->
	<center>[[File:~~createnewsurvey~~.png]]</center>		<center>[[File:version.png]]</center>


Line 95:		Line 95:

	<!--T:23-->		<!--T:23-->
	<center>[[File:~~createnewsurvey~~.png]]</center>		<center>[[File:helper.png]]</center>


	<!--T:24-->		<!--T:24-->
	<center>[[File:~~createnewsurvey~~.png]]</center>		<center>[[File:menu_items.png]]</center>

	</translate>		</translate>

Galads at 11:29, 25 January 2021

2021-01-25T11:29:23Z

← Older revision		Revision as of 13:29, 25 January 2021
Line 31:		Line 31:

	<!--T:8-->		<!--T:8-->
	Example:		'''Example:'''


Line 58:		Line 58:

	<!--T:14-->		<!--T:14-->
	Example:		'''Example:'''


Line 90:		Line 90:

	<!--T:22-->		<!--T:22-->
	Example:		'''Example:'''

Galads at 11:28, 25 January 2021

2021-01-25T11:28:38Z

← Older revision		Revision as of 13:28, 25 January 2021
Line 16:		Line 16:

	<!--T:4-->		<!--T:4-->
	Example:		'''Example:'''

	<!--T:5-->		<!--T:5-->

Galads at 11:26, 25 January 2021

2021-01-25T11:26:12Z

← Older revision		Revision as of 13:26, 25 January 2021
Line 1:		Line 1:
	~~Technical changes~~		<languages />
	~~The new XML config file~~		<translate>


			=Technical changes= <!--T:1-->

			==The new XML config file ==<!--T:2-->


			<!--T:3-->
	Since LimeSurvey 4.0, plugins need a XML config file to be run in the application.		Since LimeSurvey 4.0, plugins need a XML config file to be run in the application.

Line 8:		Line 15:
	This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development wiki at https://manual.limesurvey.org/Plugins_-_advanced#Available_plugins		This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development wiki at https://manual.limesurvey.org/Plugins_-_advanced#Available_plugins

			<!--T:4-->
	Example:		Example:

			<!--T:5-->
			<center>[[File:createnewsurvey.png]]</center>


	The new plugin directory		==The new plugin directory==<!--T:6-->

			<!--T:7-->
	The plugin directory is changed in LimeSurvey 4. For security reasons, the plugin directory is now located in the upload directory (/upload/plugins) due to the new plugin manager (Plugin uploader).		The plugin directory is changed in LimeSurvey 4. For security reasons, the plugin directory is now located in the upload directory (/upload/plugins) due to the new plugin manager (Plugin uploader).
	For manual uploads, we recommend to upload your files to the new directory to avoid software malfunctioning.		For manual uploads, we recommend to upload your files to the new directory to avoid software malfunctioning.
Line 19:		Line 30:
	Make sure to change or add the new directory if it is hard-coded in your plugin.		Make sure to change or add the new directory if it is hard-coded in your plugin.

			<!--T:8-->
	Example:		Example:


			<!--T:9-->
			<center>[[File:createnewsurvey.png]]</center>


	The new plugin events		==The new plugin events==<!--T:10-->



			<!--T:11-->
	Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.		Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.
	For more information check our development manual on plugin events at https://manual.limesurvey.org/Plugin_events		For more information check our development manual on plugin events at https://manual.limesurvey.org/Plugin_events

	Deprecated functions and methods
			==Deprecated functions and methods==<!--T:12-->


			<!--T:13-->
	Since the code base or structure of LimeSurvey 4 changed, there are a lot of methods or functions that are not used anymore.		Since the code base or structure of LimeSurvey 4 changed, there are a lot of methods or functions that are not used anymore.
	To fix this problem, you need to enable the debug mode on the config.php file first and then go to the plugin page. Any method that does not exit anymore will be shown on the error page.		To fix this problem, you need to enable the debug mode on the config.php file first and then go to the plugin page. Any method that does not exit anymore will be shown on the error page.
Line 35:		Line 56:
	Some of the methods are renamed in LS4 or are not used anymore. To be sure that your plugin works for both LS3 & LS4, check the version of LS before calling the method you need.		Some of the methods are renamed in LS4 or are not used anymore. To be sure that your plugin works for both LS3 & LS4, check the version of LS before calling the method you need.


			<!--T:14-->
	Example:		Example:


			<!--T:15-->
			<center>[[File:createnewsurvey.png]]</center>


	Best Practice		=Best Practice=<!--T:16-->

	~~Avoid SVG files~~


			==Avoid SVG files==<!--T:17-->



			<!--T:18-->
	For security (XSS) reasons, the upload of SVG Files is not possible. The Plugin uploader will ignore SVG files. Replace them by PNG or JPEG files.		For security (XSS) reasons, the upload of SVG Files is not possible. The Plugin uploader will ignore SVG files. Replace them by PNG or JPEG files.
	The upload of SVG files is possible only if you have access to the installation directory via ftp or other server tools (Upload any files at your own risks).		The upload of SVG files is possible only if you have access to the installation directory via ftp or other server tools (Upload any files at your own risks).

	~~Avoid global constants~~

			==Avoid global constants==<!--T:19-->



			<!--T:20-->
	Avoid the use of global constants that can collapse with variables of the core application or other plugins like „ROOT_PATH“. Don‘t use global constant in general for plugin development.		Avoid the use of global constants that can collapse with variables of the core application or other plugins like „ROOT_PATH“. Don‘t use global constant in general for plugin development.
	~~Use Namespaces~~

			==Use Namespaces== <!--T:21-->
	Use namespace for better organization by grouping classes that work together to perform a task in your plugin. In that way you avoid using classes that are being used already in the core application.		Use namespace for better organization by grouping classes that work together to perform a task in your plugin. In that way you avoid using classes that are being used already in the core application.


			<!--T:22-->
			Example:



			<!--T:23-->
			<center>[[File:createnewsurvey.png]]</center>


	~~Example~~:		<!--T:24-->
			<center>[[File:createnewsurvey.png]]</center>

			</translate>

Galads at 10:53, 25 January 2021

2021-01-25T10:53:50Z

← Older revision		Revision as of 12:53, 25 January 2021
Line 1:		Line 1:
	~~Text~~		Technical changes
			The new XML config file

			Since LimeSurvey 4.0, plugins need a XML config file to be run in the application.

			The reason for this is the possibility to store meta-data information such as plugin Author, support email or updaters information.

			This XML file is mandatory in LimeSurvey 4. It should be located in the root directory of the plugin. For more information check the plugin development wiki at https://manual.limesurvey.org/Plugins_-_advanced#Available_plugins

			Example:



			The new plugin directory

			The plugin directory is changed in LimeSurvey 4. For security reasons, the plugin directory is now located in the upload directory (/upload/plugins) due to the new plugin manager (Plugin uploader).
			For manual uploads, we recommend to upload your files to the new directory to avoid software malfunctioning.

			Make sure to change or add the new directory if it is hard-coded in your plugin.

			Example:




			The new plugin events

			Some plugin events from LS3 were deprecated. Use the new plugin events introduced in LS4 to replace the old plugin events.
			For more information check our development manual on plugin events at https://manual.limesurvey.org/Plugin_events

			Deprecated functions and methods
			Since the code base or structure of LimeSurvey 4 changed, there are a lot of methods or functions that are not used anymore.
			To fix this problem, you need to enable the debug mode on the config.php file first and then go to the plugin page. Any method that does not exit anymore will be shown on the error page.

			Some of the methods are renamed in LS4 or are not used anymore. To be sure that your plugin works for both LS3 & LS4, check the version of LS before calling the method you need.

			Example:



			Best Practice

			Avoid SVG files

			For security (XSS) reasons, the upload of SVG Files is not possible. The Plugin uploader will ignore SVG files. Replace them by PNG or JPEG files.
			The upload of SVG files is possible only if you have access to the installation directory via ftp or other server tools (Upload any files at your own risks).

			Avoid global constants

			Avoid the use of global constants that can collapse with variables of the core application or other plugins like „ROOT_PATH“. Don‘t use global constant in general for plugin development.
			Use Namespaces

			Use namespace for better organization by grouping classes that work together to perform a task in your plugin. In that way you avoid using classes that are being used already in the core application.



			Example:

Cdorin: Created page with "Text"

2021-01-20T09:26:52Z

Created page with "Text"

New page

Text