Actions

Difference between revisions of "BeforeQuestionRender"

From LimeSurvey Manual

({{newIn|3.5.5}} for aHtmlOptions)
m
Line 3: Line 3:
 
'''When'''
 
'''When'''
  
This event happen when question part from template is displayed.
+
This event is triggered when a question part from the template is displayed.
  
 
'''Input'''
 
'''Input'''
Line 11: Line 11:
 
* ''surveyId'' the id of the current survey
 
* ''surveyId'' the id of the current survey
 
* ''type'' the code of the [[Question_types|question type]]
 
* ''type'' the code of the [[Question_types|question type]]
* ''code' the question code
+
* ''code" the question code
 
* ''qid'' the id of the current question
 
* ''qid'' the id of the current question
* ''gid'' the id of the current group
+
* ''gid" the id of the current group
* ''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
* ''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)
 
* ''answers'' the complete HTML answers part  
 
* ''answers'' the complete HTML answers part  
 
* ''help'' the question help text, by LimeSurvey
 
* ''help'' the question help text, by LimeSurvey

Revision as of 08:03, 24 July 2018

TODO: This event is not completely compatible with 3.x yet.

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
  • 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 (Expression Manager)
  • 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 }}
  • "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

// todo