Actions

Difference between revisions of "BeforeQuestionRender"

From LimeSurvey Manual

(Add aHtmlOptions)
Line 27: Line 27:
  
 
'''Possible output'''
 
'''Possible output'''
* ''text'' new text for the question : in template {QUESTION_TEXT}
+
* ''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 {QUESTION_CLASS}
+
* ''class'' new question css class for the question : in template : <code><nowiki>{{ aQuestion.class }}</nowiki></code>
 
* "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 {QUESTION_INPUT_ERROR_CLASS}
+
* "input_error_class" new question css class for the question : in template <code><nowiki>{{ aQuestion.input_error_class }}</nowiki></code>
* ''answers'' new HTML for answer part rendering
+
* ''answers'' new HTML for answer part rendering : <code><nowiki>{{ aQuestion.answer | raw}}</nowiki></code>
* ''help'' new help text for the question : in template {QUESTION_HELP}
+
* ''help'' new help text for the question : <code><nowiki>{{ aQuestion.help.text | raw }}</nowiki></code>
* ''man_message'' new mandatory message (QUESTION_MAN_MESSAGE}
+
* ''man_message'' new mandatory message : <code><nowiki>{{ aQuestion.man_message        | raw }}</nowiki></code>
* ''valid_message'' new validation html message (QUESTION_VALID_MESSAGE}
+
* ''valid_message'' new validation html message : <code><nowiki>{{ aQuestion.valid_message        | raw }}</nowiki></code>
* ''file_valid_message'' new validation html message for upload question type (QUESTION_FILE_VALID_MESSAGE}
+
* ''file_valid_message'' new validation html message for upload question type : <code><nowiki>{{ aQuestion.file_valid_message        | raw }}</nowiki></code>
* ''mandatory'' HTML to produce for mandatory {QUESTION_MANDATORY}
+
* ''mandatory'' HTML to produce for mandatory <code><nowiki>{{ aQuestion.attributes }}</nowiki></code> {QUESTION_MANDATORY}
* ''aHtmlOptions'' New wrapper html options (in array), id was replaced by core system and can not be added here.
+
* ''aHtmlOptions'' New wrapper html options (in array), id was replaced by core system and can not be added here <code><nowiki>{{ aQuestion.attributes }}</nowiki></code>
  
 
'''Example'''
 
'''Example'''

Revision as of 11:00, 26 March 2018

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

When

This event happen when question part from 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.attributes }} {QUESTION_MANDATORY}
  • aHtmlOptions New wrapper html options (in array), id was replaced by core system and can not be added here {{ aQuestion.attributes }}

Example

// todo