Actions

ExpressionManagerStart: Difference between revisions

From LimeSurvey Manual

(Add Function definition)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''When'''
{{FeatureStarting|4.0.0}}


This event is fired before show the survey menu bar
== Usage ==


'''Input'''
This event is done when ExpressionScript create his own function. It allow to create own Expressioon Manager function.
 
== Input ==


None
None


'''Possible output'''
== Possible output ==


* functions : array of new function for expression manager
* functions : array of new function for expression manager
* packages : array of javascript package to be registred
* packages : array of javascript package to be registered just after the expression manager javascript.


'''Functions definition'''
=== Function definition ===
Function is defined by an array with  
Function is defined by an array (0 indexed array) with  
* PHP function, can use complete Class name
* PHP function, can use complete Class name
* Javascript function
* Javascript function: null for a static function (no javascript update)
* Basic description for administration GUI
* Basic description for administration GUI
* Usage for administration GUI
* Usage for administration GUI
* Help url
* Help url
* Number of argument , -1 mean any number of arguments.
* Number of argument : list of number of allowed argument
** 1, 2 : 1 or 2 arguments
** 1, 2, 3, 4 : 1, 2, 3 or 4 arguments
** 2, 4 : 2 or 4 arguments
** -1 mean any number of arguments.


'''Example'''
== Example ==


* [https://github.com/LimeSurvey/LimeSurvey/tree/master/plugins/Demo/demoAddEmFunction demoAddEmFunction]
* [https://github.com/LimeSurvey/LimeSurvey/tree/master/plugins/Demo/demoAddEmFunction demoAddEmFunction]
 
* [https://github.com/LimeSurvey/LimeSurvey/tree/master/application/core/plugins/statFunctions statFunctions]
[[Category:Plugins events]]
[[Category:Plugins events]]

Latest revision as of 15:17, 1 April 2022

 Hint: This features is available starting in version 4.0.0


Usage

This event is done when ExpressionScript create his own function. It allow to create own Expressioon Manager function.

Input

None

Possible output

  • functions : array of new function for expression manager
  • packages : array of javascript package to be registered just after the expression manager javascript.

Function definition

Function is defined by an array (0 indexed array) with

  • PHP function, can use complete Class name
  • Javascript function: null for a static function (no javascript update)
  • Basic description for administration GUI
  • Usage for administration GUI
  • Help url
  • Number of argument : list of number of allowed argument
    • 1, 2 : 1 or 2 arguments
    • 1, 2, 3, 4 : 1, 2, 3 or 4 arguments
    • 2, 4 : 2 or 4 arguments
    • -1 mean any number of arguments.

Example