Actions

Difference between revisions of "BeforeQuestionRender"

From LimeSurvey Manual

m (Text replacement - "Expression Manager" to "ExpressionScript")
(FeatureChange)
 
Line 1: Line 1:
TODO: This event is not completely compatible with 3.x yet.
+
{{FeatureChange|3.4}}
  
 
'''When'''
 
'''When'''
Line 16: Line 16:
 
* ''text'' the question text
 
* ''text'' the question text
 
* ''questionhelp'' the question help (by admin user)
 
* ''questionhelp'' the question help (by admin user)
* ''class'' the question css class
+
* ''class'' the question css class {{NewIn|3.6.0}}
 
* ''man_class'' the mandatory css class (mandatory and/or missing or empty)
 
* ''man_class'' the mandatory css class (mandatory and/or missing or empty)
 
* ''input_error_class'' the input error css class (input-error or empty)
 
* ''input_error_class'' the input error css class (input-error or empty)
Line 29: Line 29:
 
* ''text'' new text for the question : in template :  <code><nowiki>{{ aQuestion.text | raw }}</nowiki></code>
 
* ''text'' new text for the question : in template :  <code><nowiki>{{ aQuestion.text | raw }}</nowiki></code>
 
* ''questionhelp'' : new question help {QUESTIONHELP}
 
* ''questionhelp'' : new question help {QUESTIONHELP}
* ''class'' new question css class for the question : in template : <code><nowiki>{{ aQuestion.class }}</nowiki></code>
+
* ''class'' new question css class for the question : in template : <code><nowiki>{{ aQuestion.class }}</nowiki></code> {{NewIn|3.6.0}}
 
* ''man_class'' new question css class for the question : in template {QUESTION_MAN_CLASS}
 
* ''man_class'' new question css class for the question : in template {QUESTION_MAN_CLASS}
 
* ''input_error_class'' new question css class for the question : in template <code><nowiki>{{ aQuestion.input_error_class }}</nowiki></code>
 
* ''input_error_class'' new question css class for the question : in template <code><nowiki>{{ aQuestion.input_error_class }}</nowiki></code>
Line 41: Line 41:
  
 
'''Example'''
 
'''Example'''
 
<syntaxhighlight lang="php">
 
// todo
 
</syntaxhighlight>
 
  
 
[[Category:Plugins events]]
 
[[Category:Plugins events]]

Latest revision as of 12:52, 30 October 2020

Notice.png
 Hint: This feature changed with version 3.4


When

This event is triggered when a question part from the template is displayed.

Input

The event receives the following information:

  • surveyId the id of the current survey
  • type the code of the question type
  • code the question code
  • qid the id of the current question
  • gid the id of the current group
  • text the question text
  • questionhelp the question help (by admin user)
  • class the question css class (New in 3.6.0 )
  • man_class the mandatory css class (mandatory and/or missing or empty)
  • input_error_class the input error css class (input-error or empty)
  • answers the complete HTML answers part
  • help the question help text, by LimeSurvey
  • man_message the mandatory error message
  • valid_message the question validation HTML message (ExpressionScript)
  • file_valid_message the question validation HTML message for upload question type
  • aHtmlOptions The actual option for the question part in array

Possible output

  • text new text for the question : in template : {{ aQuestion.text | raw }}
  • questionhelp : new question help {QUESTIONHELP}
  • class new question css class for the question : in template : {{ aQuestion.class }} (New in 3.6.0 )
  • man_class new question css class for the question : in template {QUESTION_MAN_CLASS}
  • input_error_class new question css class for the question : in template {{ aQuestion.input_error_class }}
  • answers new HTML for answer part rendering : {{ aQuestion.answer | raw}}
  • help new help text for the question : {{ aQuestion.help.text | raw }}
  • man_message new mandatory message : {{ aQuestion.man_message | raw }}
  • valid_message new validation html message : {{ aQuestion.valid_message | raw }}
  • file_valid_message new validation html message for upload question type : {{ aQuestion.file_valid_message | raw }}
  • mandatory HTML to produce for mandatory {{ aQuestion.mandatory }}
  • aHtmlOptions New wrapper html options (in array), id was replaced by core system and can not be added here {{ aQuestion.attributes }} (New in 3.5.5 )

Example