Dev: More phpdoc in qanda

LimeSurvey · Sep 4, 2016 · 29741d6 · 29741d6
1 parent 3c4c4dc
commit 29741d6
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/application/helpers/qanda_helper.php b/application/helpers/qanda_helper.php
@@ -76,12 +76,26 @@ function setNoAnswerMode($thissurvey)
 * @param array $ia Details of $ia can be found at top of this file
 * @return array Array like [array $qanda, array $inputnames] where
 *               $qanda has elements [
-*                 $qtitle : string? what's the content?
+*                 $qtitle (question_text) : array [
+                        all : string; complete HTML?; all has been added for backwards compatibility with templates that use question_start.pstpl (now redundant)
+                        'text'               => $qtitle, question?? $ia[3]?
+                        'code'               => $ia[2] or title??
+                        'number'             => $number
+                        'help'               => ''
+                        'mandatory'          => ''
+                        man_message : string; message when mandatory is not answered
+                        'valid_message'      => ''
+                        file_valid_message : string; only relevant for file upload
+                        'class'              => ''
+                        'man_class'          => ''
+                        'input_error_class'  => ''              // provides a class.
+                        'essentials'         => ''
+*                 ]
 *                 $answer ?
 *                 'help' : string
 *                 $display : ?
 *                 $qid  : integer
-*                 $ia[2]
+*                 $ia[2] = title;
 *                 $ia[5] = group id : int
 *                 $ia[1] = fieldname : string
 *               ]