/
em_manager_helper.php
10004 lines (9483 loc) · 493 KB
/
em_manager_helper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* LimeSurvey
* Copyright (C) 2007-2011 The LimeSurvey Project Team / Carsten Schmitz
* All rights reserved.
* License: GNU/GPL License v2 or later, see LICENSE.php
* LimeSurvey is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*
*/
/**
* Description of LimeExpressionManager
* This is a wrapper class around ExpressionManager that implements a Singleton and eases
* passing of LimeSurvey variable values into ExpressionManager
*
* @author LimeSurvey Team (limesurvey.org)
* @author Thomas M. White (TMSWhite)
*/
include_once('em_core_helper.php');
Yii::app()->loadHelper('database');
Yii::app()->loadHelper('frontend');
Yii::app()->loadHelper('surveytranslator');
Yii::import("application.libraries.Date_Time_Converter");
define('LEM_DEBUG_TIMING',1);
define('LEM_DEBUG_VALIDATION_SUMMARY',2); // also includes SQL error messages
define('LEM_DEBUG_VALIDATION_DETAIL',4);
define('LEM_PRETTY_PRINT_ALL_SYNTAX',32);
define('LEM_DEFAULT_PRECISION',12);
class LimeExpressionManager {
/**
* LimeExpressionManager is a singleton. $instance is its storage location.
* @var LimeExpressionManager
*/
private static $instance;
/**
* Implements the recursive descent parser that processes expressions
* @var ExpressionManager
*/
private $em;
/**
*
* @var type
*/
private $groupRelevanceInfo;
/**
* The survey ID
* @var integer
*/
private $sid;
/**
* sum of LEM_DEBUG constants - use bitwise AND comparisons to identify which parts to use
* @var type
*/
private $debugLevel=0;
/**
* sPreviewMode used for relevance equation force to 1 in preview mode
* Maybe we can set it public
* @var string
*/
private $sPreviewMode=false;
/**
* Collection of variable attributes, indexed by SGQA code
*
* Actual variables are stored in this structure:
* $knownVars[$sgqa] = array(
* 'jsName_on' => // the name of the javascript variable if it is defined on the current page - often 'answerSGQA'
* 'jsName' => // the name of the javascript variable when referenced on different pages - usually 'javaSGQA'
* 'readWrite' => // 'Y' for yes, 'N' for no - currently not used
* 'hidden' => // 1 if the question attribute 'hidden' is true, otherwise 0
* 'question' => // the text of the question (or sub-question)
* 'qid' => // the numeric question id - e.g. the Q part of the SGQA name
* 'gid' => // the numeric group id - e.g. the G part of the SGQA name
* 'grelevance' => // the group level relevance string
* 'relevance' => // the question level relevance string
* 'qcode' => // the qcode-style variable name for this question (or sub-question)
* 'qseq' => // the 0-based index of the question within the survey
* 'gseq' => // the 0-based index of the group within the survey
* 'type' => // the single character type code for the question
* 'sgqa' => // the SGQA name for the variable
* 'ansList' => // ansArray converted to a JavaScript fragment - e.g. ",'answers':{ 'M':'Male','F':'Female'}"
* 'ansArray' => // PHP array of answer strings, keyed on the answer code = e.g. array['M']='Male';
* 'scale_id' => // '0' for most answers. '1' for second scale within dual-scale questions
* 'rootVarName' => // the root code / name / title for the question, without any sub-question or answer-level suffix. This is from the title column in the questions table
* 'subqtext' => // the sub-question text
* 'rowdivid' => // the JavaScript ID of the row identifier for a question. This is used to show/hide entire question rows
* 'onlynum' => // 1 if only numbers are allowed for this variable. If so, then extra processing is needed to ensure that can use comma as a decimal separator
* );
*
* Reserved variables (e.g. TOKEN:xxxx) are stored with this structure:
* $knownVars[$token] = array(
* 'code' => // the static value for the variable
* 'type' => // ''
* 'jsName_on' => // ''
* 'jsName' => // ''
* 'readWrite' => // 'N' - since these are always read-only variables
* );
*
* @var type
*/
private $knownVars;
/**
* maps qcode varname to SGQA code
*
* @example ['gender'] = '38612X10X145'
* @var type
*/
private $qcode2sgqa;
/**
* variables temporarily set for substitution purposes
*
* These are typically the LimeReplacement Fields passed in via templatereplace()
* Each has the following structure: array(
* 'code' => // the static value of the variable
* 'jsName_on' => // ''
* 'jsName' => // ''
* 'readWrite' => // 'N'
* );
*
* @var type
*/
private $tempVars;
/**
* Array of relevance information for each page (gseq), indexed by gseq.
* Within a page, it contains a sequential list of the results of each relevance equation processed
* array(
* 'qid' => // question id -- e.g. 154
* 'gseq' => // 0-based group sequence -- e.g. 2
* 'eqn' => // the raw relevance equation parsed -- e.g. "!is_empty(p2_sex)"
* 'result' => // the Boolean result of parsing that equation in the current context -- e.g. 0
* 'numJsVars' => // the number of dynamic JavaScript variables used in that equation -- e.g. 1
* 'relevancejs' => // the actual JavaScript to insert for that relevance equation -- e.g. "LEMif(LEManyNA('p2_sex'),'',( ! LEMempty(LEMval('p2_sex') )))"
* 'relevanceVars' => // a pipe-delimited list of JavaScript variables upon which that equation depends -- e.g. "java38612X12X153"
* 'jsResultVar' => // the JavaScript variable in which that result will be stored -- e.g. "java38612X12X154"
* 'type' => // the single character type of the question -- e.g. 'S'
* 'hidden' => // 1 if the question should always be hidden
* 'hasErrors' => // 1 if there were parsing errors processing that relevance equation
* @var type
*/
private $pageRelevanceInfo;
/**
*
* @var type
*/
private $pageTailorInfo;
/**
* internally set to true (1) for survey.php so get group-specific logging but keep javascript variable namings consistent on the page.
* @var type
*/
private $allOnOnePage=false;
/**
* survey mode. One of 'survey', 'group', or 'question'
* @var string
*/
private $surveyMode='group';
/**
* a set of global survey options passed from LimeSurvey
*
* For example, array(
* 'rooturl' => // URL prefix needed to be able to click on a syntax-highlighted variable name and have it open the needed editting window
* 'hyperlinkSyntaxHighlighting' => // true if should be able to click on variables to edit them
* 'active' => // 0 for inactive, 1 for active survey
* 'allowsave' => // 0 for do not allow save; 1 for allow save
* 'anonymized' => // 1 for anonymous
* 'assessments' => // 1 for use assessments
* 'datestamp' => // 1 for use date stamps
* 'ipaddr' => // 1 for capture IP address
* 'radix' => // '.' for use period as decimal separator; ',' for use comma as decimal separator
* 'savetimings' => // "Y" if should save survey timings
* 'startlanguage' => // the starting language -- e.g. 'en'
* 'surveyls_dateformat' => // the index of the language specific date format -- e.g. 1
* 'tablename' => // the name of the table storing the survey data, if active -- e.g. lime_survey_38612
* 'target' => // the path for uploading files -- e.g. '/temp/files/'
* 'timeadjust' => // the time offset -- e.g. 0
* 'tempdir' => // the temporary directory for uploading files -- e.g. '/temp/'
* );
*
* @var type
*/
private $surveyOptions=array();
/**
* array of mappings of Question # (qid) to pipe-delimited list of SGQA codes used within it
*
* @example [150] = "38612X11X150|38612X11X150other"
* @var type
*/
private $qid2code;
/**
* array of mappings of JavaScript Variable names to Question number (qid)
*
* @example ['java38612X13X161other'] = '161'
* @var type
*/
private $jsVar2qid;
/**
* maps name of the variable to the SGQ name (without the A suffix)
*
* @example ['p1_sex'] = "38612X10X147"
* @example ['afDS_sq1_1'] = "26626X37X705sq1#1"
* @var type
*/
private $qcode2sgq;
/**
* array of mappings of knownVar aliases to the JavaScript variable names.
* This maps both the SGQA and qcode alias names to the same 2 dimensional array
*
* @example ['p1_sex'] = array(
* 'jsName' => // the JavaScript variable name used by EM -- e.g. "java38612X11X147"
* 'jsPart' => // the JavaScript fragment used in EM's ____ array -- e.g. "'p1_sex':'java38612X11X147'"
* );
* @example ['afDS_sq1_1] = array(
* 'jsName' => "java26626X37X705sq1#1"
* 'jsPart' => "'afDS_sq1_1':'java26626X37X705sq1#1'"
* );
* @var type
*/
private $alias2varName;
/**
* JavaScript array of mappings of canonical JavaScript variable name to key attributes.
* These fragments are used to create the JavaScript varNameAttr array.
*
* @example ['java38612X11X147'] = "'java38612X11X147':{ 'jsName':'java38612X11X147','jsName_on':'java38612X11X147','sgqa':'38612X11X147','qid':147,'gid':11,'type':'G','default':'','rowdivid':'','onlynum':'','gseq':1,'answers':{ 'M':'Male','F':'Female'}}"
* @example ['java26626X37X705sq1#1'] = "'java26626X37X705sq1#1':{ 'jsName':'java26626X37X705sq1#1','jsName_on':'java26626X37X705sq1#1','sgqa':'26626X37X705sq1#1','qid':705,'gid':37,'type':'1','default':'','rowdivid':'26626X37X705sq1','onlynum':'','gseq':1,'answers':{ '0~1':'1|Low','0~2':'2|Medium','0~3':'3|High','1~1':'1|Never','1~2':'2|Sometimes','1~3':'3|Always'}}"
*
* @var type
*/
private $varNameAttr;
/**
* array of enumerated answer lists indexed by qid
* These use a tilde syntax to indicate which scale the answer is part of.
*
* @example ['0~4'] = "4|Child" // this means that code 4 in scale 0 has a coded value of 4 and a display value of 'Child'
* @example (for [705]): ['1~2'] = '2|Sometimes' // this means that the second scale for this question uses the coded value of 2 to represent 'Sometimes'
* @example // TODO - add example from survey using assessments
*
* @var type
*/
private $qans;
/**
* map of gid to 0-based sequence number of groups
*
* @example [10] = 0 // means that the first group (gseq=0) has gid=10
*
* @var type
*/
private $groupId2groupSeq;
/**
* map question # to an incremental count of question order across the whole survey
*
* @example [157] = 13 // means that that 14th question in the survey has qid=157
*
* @var type
*/
private $questionId2questionSeq;
/**
* map question # to the group it is within, using an incremental count of group order
*
* @example [157] = 2 // means that qid 157 is in the 3rd page of questions (gseq = 2)
*
* @var type
*/
private $questionId2groupSeq;
/**
* array of info about each Group, indexed by GroupSeq
*
* @example [2] = array(
* 'qstart' => 9 // the first qseq within that group
* 'qend' => 13 //the last qseq within that group
* );
*
* @var type
*/
private $groupSeqInfo;
/**
* tracks which groups have at least one relevant, non-hidden question
*
* @example [2] = 0 // means that the third group (gseq==2) is currently irrelevant
*
* @var type
*/
private $gseq2relevanceStatus;
/**
* maps question # to the validation equation(s) for that question.
* These are grouped by qid then validation type, such as 'value_range', and 'num_answers'
*
* @example [703] = array(
* 'eqn' => array(
* 'value_range' = "((is_empty(26626X34X703.NAOK) || 26626X34X703.NAOK >= (0)) and (is_empty(26626X34X703.NAOK) || 26626X34X703.NAOK <= (5)))"
* ),
* 'tips' => array(
* 'value_range' = "Each answer must be between {fixnum(0)} and {fixnum(5)}"
* ),
* 'subqValidEqns' = array(
* [] = array(
* 'subqValidSelector' => '' //
* 'subqValidEqn' => "(is_empty(26626X34X703.NAOK) || 26626X34X703.NAOK >= (0)) && (is_empty(26626X34X703.NAOK) || 26626X34X703.NAOK <= (5))"
* ),
* 'sumEqn' => '' // the equation to compute the current sum of the responses
* 'sumRemainingEqn' => '' // the equation to how much is left (for the question attribute that lets you specify the exact value of the sum of the answers)
* );
*
* @var type
*/
private $qid2validationEqn;
/**
* keeps relevance in proper sequence so can minimize relevance processing to see what should be see on page and in indexes
* Array is indexed on qseq
*
* @example [3] = array(
* 'relevance' => "!is_empty(num)" // the question-level relevance equation
* 'grelevance' => "" // the group-level relevance equation
* 'qid' => "699" // the question id
* 'qseq' => 3 // the 0-index question sequence
* 'gseq' => 0 // the 0-index group sequence
* 'jsResultVar_on' => 'answer26626X34X699' // the javascript variable holding the input value
* 'jsResultVar' => 'java26226X34X699' // the javascript variable (often hidden) holding the value to be submitted
* 'type' => 'N' // the one character question type
* 'hidden' => 0 // 1 if it should be always_hidden
* 'gid' => "34" // group id
* 'mandatory' => 'N' // 'Y' if mandatory
* 'eqn' => "" // TODO ??
* 'help' => "" // the help text
* 'qtext' => "Enter a larger number than {num}" // the question text
* 'code' => 'afDS_sq5_1' // the full variable name
* 'other' => 'N' // whether the question supports the 'other' option - 'Y' if true
* 'rowdivid' => '2626X37X705sq5' // the javascript id for the row - in this case, the 5th sub-question
* 'aid' => 'sq5' // the answer id
* 'sqid' => '791' // the sub-question's qid (only populated for some question types)
* );
*
* @var type
*/
private $questionSeq2relevance;
/**
* current Group sequence (0-based index)
* @example 1
* @var integer
*/
private $currentGroupSeq;
/**
* for Question-by-Question mode, the 0-based index
* @example 3
* @var integer
*/
private $currentQuestionSeq;
/**
* used in Question-by-Question mode
* @var integer
*/
private $currentQID;
/**
* set of the current set of questions to be displayed, indexed by QID - at least one must be relevant
*
* The array has N entries, where N is the number if qids in the Qset. Each has the following contents:
* @example [705] = array(
* 'info' => array() // this is an exact copy of $questionSeq2relevance[$qseq] -- TODO - remove redundancy
* 'relevant' => 1 // 1 if the question is currently relevant
* 'hidden' => 0 // 1 if the question is always hidden
* 'relEqn' => '' // the relevance equation -- TODO - how different from ['info']['relevance']?
* 'sgqa' => // pipe-separated list of SGQA codes for this question -- e.g. "26626X37X705sq1#0|26626X37X705sq1#1|26626X37X705sq2#0|26626X37X705sq2#1|26626X37X705sq3#0|26626X37X705sq3#1|26626X37X705sq4#0|26626X37X705sq4#1|26626X37X705sq5#0|26626X37X705sq5#1"
* 'unansweredSQs' => // pipe-separated list of currently unanswered SGQA codes for this question -- e.g. "26626X37X705sq1#0|26626X37X705sq1#1|26626X37X705sq3#0|26626X37X705sq3#1|26626X37X705sq5#0|26626X37X705sq5#1"
* 'valid' => 0 // 1 if the current answers pass all of the validation criteria for the question
* 'validEqn' => // the auto-generated validation criteria, based upon advanced question attributes -- e.g. "((count(if(count(26626X37X705sq1#0.NAOK,26626X37X705sq1#1.NAOK)==2,1,''), if(count(26626X37X705sq2#0.NAOK,26626X37X705sq2#1.NAOK)==2,1,''), if(count(26626X37X705sq3#0.NAOK,26626X37X705sq3#1.NAOK)==2,1,''), if(count(26626X37X705sq4#0.NAOK,26626X37X705sq4#1.NAOK)==2,1,''), if(count(26626X37X705sq5#0.NAOK,26626X37X705sq5#1.NAOK)==2,1,'')) >= (minSelect)) and (count(if(count(26626X37X705sq1#0.NAOK,26626X37X705sq1#1.NAOK)==2,1,''), if(count(26626X37X705sq2#0.NAOK,26626X37X705sq2#1.NAOK)==2,1,''), if(count(26626X37X705sq3#0.NAOK,26626X37X705sq3#1.NAOK)==2,1,''), if(count(26626X37X705sq4#0.NAOK,26626X37X705sq4#1.NAOK)==2,1,''), if(count(26626X37X705sq5#0.NAOK,26626X37X705sq5#1.NAOK)==2,1,'')) <= (maxSelect)))"
* 'prettyValidEqn' => // syntax-highlighted version of validEqn, only showing syntax errors
* 'validTip' => // html fragment to insert for the validation tip -- e.g. "<div id='vmsg_705_num_answers' class='em_num_answers'>Please select between 1 and 3 answer(s)</div>"
* 'prettyValidTip' => // version of validTip that can be parsed by EM to create dynmamic validation -- e.g. "<div id='vmsg_705_num_answers' class='em_num_answers'>Please select between {fixnum(minSelect)} and {fixnum(maxSelect)} answer(s)</div>"
* 'validJS' => // JavaScript fragment that can perform validation. This is the result of parsing validEqn -- e.g. "LEMif(LEManyNA('minSelect', 'maxSelect'),'',(((LEMcount(LEMif(LEMcount(LEMval('26626X37X705sq1#0.NAOK') , LEMval('26626X37X705sq1#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq2#0.NAOK') , LEMval('26626X37X705sq2#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq3#0.NAOK') , LEMval('26626X37X705sq3#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq4#0.NAOK') , LEMval('26626X37X705sq4#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq5#0.NAOK') , LEMval('26626X37X705sq5#1.NAOK') ) == 2, 1, '')) >= (LEMval('minSelect') )) && (LEMcount(LEMif(LEMcount(LEMval('26626X37X705sq1#0.NAOK') , LEMval('26626X37X705sq1#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq2#0.NAOK') , LEMval('26626X37X705sq2#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq3#0.NAOK') , LEMval('26626X37X705sq3#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq4#0.NAOK') , LEMval('26626X37X705sq4#1.NAOK') ) == 2, 1, ''), LEMif(LEMcount(LEMval('26626X37X705sq5#0.NAOK') , LEMval('26626X37X705sq5#1.NAOK') ) == 2, 1, '')) <= (LEMval('maxSelect') )))))"
* 'invalidSQs' => // current list of subquestions that fail validation criteria -- e.g. "26626X37X705sq1#0|26626X37X705sq1#1|26626X37X705sq2#0|26626X37X705sq2#1|26626X37X705sq3#0|26626X37X705sq3#1|26626X37X705sq4#0|26626X37X705sq4#1|26626X37X705sq5#0|26626X37X705sq5#1"
* 'relevantSQs' => // current list of subquestions that are relevant -- e.g. "26626X37X705sq1#0|26626X37X705sq1#1|26626X37X705sq2#0|26626X37X705sq2#1|26626X37X705sq3#0|26626X37X705sq3#1|26626X37X705sq4#0|26626X37X705sq4#1|26626X37X705sq5#0|26626X37X705sq5#1"
* 'irrelevantSQs' => // current list of subquestions that are irrelevant -- e.g. "26626X37X705sq2#0|26626X37X705sq2#1|26626X37X705sq4#0|26626X37X705sq4#1"
* 'subQrelEqn' => // TODO - ??
* 'mandViolation' => 0 // 1 if the question is mandatory and fails the mandatory criteria
* 'anyUnanswered' => 1 // 1 if any parts of the question are unanswered
* 'mandTip' => '' // message to display if the question fails mandatory criteria
* 'message' => '' // TODO ??
* 'updatedValues' => // array of values that should be updated for this question, as [$sgqa] = $value
* 'sumEqn' => '' //
* 'sumRemainingEqn' => '' //
* );
*
* @var type
*/
private $currentQset=NULL;
/**
* last result of NavigateForwards, NavigateBackwards, or JumpTo
* Array of status information about last movement, whether at question, group, or survey level
*
* @example = array(
* 'finished' => 0 // 1 if the survey has been completed and needs to be finalized
* 'message' => '' // any error message that needs to be displayed
* 'seq' => 1 // the sequence count, using gseq, or qseq units if in 'group' or 'question' mode, respectively
* 'mandViolation' => 0 // whether there was any violation of mandatory constraints in the last movement
* 'valid' => 0 // 1 if the last movement passed all validation constraints. 0 if there were any validation errors
* 'unansweredSQs' => // pipe-separated list of any sub-questions that were not answered
* 'invalidSQs' => // pipe-separated list of any sub-questions that failed validation constraints
* );
*
* @var type
*/
private $lastMoveResult=NULL;
/**
* array of information needed to generate navigation index in question-by-question mode
* One entry for each question, indexed by qseq
*
* @example [4] = array(
* 'qid' => "700" // the question id
* 'qtext' => 'How old are you?' // the question text
* 'qcode' => 'age' // the variable name
* 'qhelp' => '' // the help text
* 'anyUnanswered' => 0 // 1 if there are any sub-questions answered. Used for index display
* 'anyErrors' => 0 // 1 if there are any errors among the sub-questions. Could be used for index display
* 'show' => 1 // 1 if there are any relevant, non-hidden sub-questions. Only if so, then display the index entry
* 'gseq' => 0 // the group sequence
* 'gtext' => // text description for the group
* 'gname' => 'G1' // the group title
* 'gid' => "34" // the group id
* 'mandViolation' => 0 // 1 if the question as a whole fails the mandatory criteria
* 'valid' => 1 // 0 if any part of the question fails validation criteria.
* );
*
* @var type
*/
private $indexQseq;
/**
* array of information needed to generate navigation index in group-by-group mode
* One entry for each group, indexed by gseq
*
* @example [0] = array(
* 'gtext' => // the description for the group
* 'gname' => 'G1' // the group title
* 'gid' => '34' // the group id
* 'anyUnanswered' => 0 // 1 if any questions within the group are unanswered
* 'anyErrors' => 0 // 1 if any of the questions within the group fail either validity or mandatory constraints
* 'valid' => 1 // 1 if at least question in the group is relevant and non-hidden
* 'mandViolation' => 0 // 1 if at least one relevant, non-hidden question in the group fails mandatory constraints
* 'show' => 1 // 1 if there is at least one relevant, non-hidden question within the group
* );
*
* @var type
*/
private $indexGseq;
/**
* array of group sequence number to static info
* One entry per group, indexed on gseq
*
* @example [0] = array(
* 'group_order' => 0 // gseq
* 'gid' => "34" // group id
* 'group_name' => 'G2' // the group title
* 'description' => // the description of the group (e.g. gtitle)
* 'grelevance' => '' // the group-level relevance
* );
*
* @var type
*/
private $gseq2info;
/**
* the maximum groupSeq reached - this is needed for Index
* @var type
*/
private $maxGroupSeq;
/**
* mapping of questions to information about their subquestions.
* One entry per question, indexed on qid
*
* @example [702] = array(
* 'qid' => 702 // the question id
* 'qseq' => 6 // the question sequence
* 'gseq' => 0 // the group sequence
* 'sgqa' => '26626X34X702' // the root of the SGQA code (reallly just the SGQ)
* 'varName' => 'afSrcFilter_sq1' // the full qcode variable name - note, if there are sub-questions, don't use this one.
* 'type' => 'M' // the one-letter question type
* 'fieldname' => '26626X34X702sq1' // the fieldname (used as JavaScript variable name, and also as database column name
* 'rootVarName' => 'afDS' // the root variable name
* 'preg' => '/[A-Z]+/' // regular expression validation equation, if any
* 'subqs' => array() of sub-questions, where each contains:
* 'rowdivid' => '26626X34X702sq1' // the javascript id identifying the question row (so array_filter can hide rows)
* 'varName' => 'afSrcFilter_sq1' // the full variable name for the sub-question
* 'jsVarName_on' => 'java26626X34X702sq1' // the JavaScript variable name if the variable is defined on the current page
* 'jsVarName' => 'java26626X34X702sq1' // the JavaScript variable name to use if the variable is defined on a different page
* 'csuffix' => 'sq1' // the SGQ suffix to use for a fieldname
* 'sqsuffix' => '_sq1' // the suffix to use for a qcode variable name
* );
*
* @var type
*/
private $q2subqInfo;
/**
* array of advanced question attributes for each question
* Indexed by qid; available for all quetions
*
* @example [784] = array(
* 'array_filter_exclude' => 'afSrcFilter'
* 'exclude_all_others' => 'sq5'
* 'max_answers' => '3'
* 'min_answers' => '1'
* 'other_replace_text' => '{afSrcFilter_other}'
* );
*
* @var type
*/
private $qattr;
/**
* list of needed sub-question relevance (e.g. array_filter)
* Indexed by qid then sgqa; only generated for current group of questions
*
* @example [708][26626X37X708sq2] = array(
* 'qid' => '708' // the question id
* 'eqn' => "((26626X34X702sq2 != ''))" // the auto-generated sub-question-level relevance equation
* 'prettyPrintEqn' => '' // only generated if there errors - shows syntax highlighting of them
* 'result' => 0 // result of processing the sub-question-level relevance equation in the current context
* 'numJsVars' => 1 // the number of on-page javascript variables in 'eqn'
* 'relevancejs' => // the generated javascript from 'eqn' -- e.g. "LEMif(LEManyNA('26626X34X702sq2'),'',(((LEMval('26626X34X702sq2') != ""))))"
* 'relevanceVars' => "java26626X34X702sq2" // the pipe-separated list of on-page javascript variables in 'eqn'
* 'rowdivid' => "26626X37X708sq2" // the javascript id of the question row (so can apply array_filter)
* 'type' => 'array_filter' // semicolon delimited list of types of subquestion relevance filters applied
* 'qtype' => 'A' // the single character question type
* 'sgqa' => "26626X37X708" // the SGQ portion of the fieldname
* 'hasErrors' => 0 // 1 if there are any parse errors in the sub-question validation equations
* );
*
* @var type
*/
private $subQrelInfo=array();
/**
* array of Group-level relevance status
* Indexed by gseq; only shows groups that have been visited
*
* @example [1] = array(
* 'gseq' => 1 // group sequence
* 'eqn' => '' // the group-level relevance
* 'result' => 1 // result of processing the group-level relevance
* 'numJsVars' => 0 // the number of on-page javascript variables in the group-level relevance equation
* 'relevancejs' => '' // the javascript version of the relevance equation
* 'relevanceVars' => '' // the pipe-delimited list of on-page javascript variable names used within the group-level relevance equation
* 'prettyPrint' => '' // a pretty-print version of the group-level relevance equation, only if there are errors
* );
*
* @var type
*/
private $gRelInfo=array();
/**
* Array of timing information to debug how long it takes for portions of LEM to run.
* Array of timing information (in seconds) for EM to help with debugging
*
* @example [1] = array(
* [0]="LimeExpressionManager::NavigateForwards"
* [1]=1.7079849243164
* );
*
* @var type
*/
private $runtimeTimings=array();
/**
* True (1) if calling LimeExpressionManager functions between StartSurvey and FinishProcessingPage
* Used (mostly deprecated) to detect calls to LEM which happen outside of the normal processing scope
* @var Boolean
*/
private $initialized=false;
/**
* True (1) if have already processed the relevance equations (so don't need to do it again)
*
* @var Boolean
*/
private $processedRelevance=false;
/**
* Message generated to show debug timing values, if debugLevel includes LEM_DEBUG_TIMING
* @var type
*/
private $debugTimingMsg='';
/**
* temporary variable to reduce need to parse same equation multiple times. Used for relevance and validation
* Array, indexed on equation, providing the following information:
*
* @example ['!is_empty(num)'] = array(
* 'result' => 1 // result of processing the equation in the current scope
* 'prettyPrint' => '' // syntax-highlighted version of equation if there are any errors
* 'hasErrors' => 0 // 1 if there are any syntax errors
* );
*
* @var type
*/
private $ParseResultCache;
/**
* array of 2nd scale answer lists for types ':' and ';' -- needed for convenient print of logic file
* Indexed on qid; available for all questions
*
* @example [706] = array(
* '1~1' => '1|Never',
* '1~2' => '2|Sometimes',
* '1~3' => '3|Always'
* );
*
* @var type
*/
private $multiflexiAnswers;
/**
* used to specify whether to generate equations using SGQA codes or qcodes
* Default is to convert all qcode naming to sgqa naming when generating javascript, as that provides the greatest backwards compatibility
* TSV export of survey structure sets this to false so as to force use of qcode naming
*
* @var Boolean
*/
private $sgqaNaming = true;
/**
* Number of groups in survey (number of possible pages to display)
* @var integer
*/
private $numGroups=0;
/**
* Numer of questions in survey (counting display-only ones?)
* @var integer
*/
private $numQuestions=0;
/**
* String identifier for the active session
* @var type
*/
private $sessid;
/**
* Linked list of array filters
* @var array
*/
private $qrootVarName2arrayFilter = array();
/**
* Array, keyed on qid, to JavaScript and list of variables needed to implement exclude_all_others_auto
* @var type
*/
private $qid2exclusiveAuto = array();
/**
* Array of values to be updated
* @var type
*/
private $updatedValues = array();
/**
* A private constructor; prevents direct creation of object
*/
private function __construct()
{
self::$instance =& $this;
$this->em = new ExpressionManager();
if (!isset($_SESSION['LEMlang'])) {
$_SESSION['LEMlang'] = 'en'; // so that there is a default
}
}
/**
* Ensures there is only one instances of LEM. Note, if switch between surveys, have to clear this cache
* @return LimeExpressionManager
*/
public static function &singleton()
{
$now = microtime(true);
if (isset($_SESSION['LEMdirtyFlag'])) {
$c = __CLASS__;
self::$instance = new $c;
unset($_SESSION['LEMdirtyFlag']);
}
else if (!isset(self::$instance)) {
if (isset($_SESSION['LEMsingleton'])) {
self::$instance = unserialize($_SESSION['LEMsingleton']);
}
else {
$c = __CLASS__;
self::$instance = new $c;
}
}
else {
// does exist, and OK to cache
return self::$instance;
}
// only record duration if have to create new (or unserialize) an instance
self::$instance->runtimeTimings[] = array(__METHOD__,(microtime(true) - $now));
return self::$instance;
}
/**
* Prevent users to clone the instance
*/
public function __clone()
{
trigger_error('Clone is not allowed.', E_USER_ERROR);
}
/**
* Set the previewmode
*/
public static function SetPreviewMode($previewmode=false)
{
$LEM =& LimeExpressionManager::singleton();
$LEM->sPreviewMode=$previewmode;
//$_SESSION[$LEM->sessid]['previewmode']=$previewmode;
}
/**
* Tells Expression Manager that something has changed enough that needs to eliminate internal caching
*/
public static function SetDirtyFlag()
{
$_SESSION['LEMdirtyFlag'] = true;// For fieldmap and other. question help {HELP} is taken from fieldmap
$_SESSION['LEMforceRefresh'] = true;// For Expression manager string
}
/**
* Set the SurveyId - really checks whether the survey you're about to work with is new, and if so, clears the LEM cache
* @param <integer> $sid
*/
public static function SetSurveyId($sid=NULL)
{
if (!is_null($sid)) {
if (isset($_SESSION['LEMsid']) && $sid != $_SESSION['LEMsid']) {
// then trying to use a new survey - so clear the LEM cache
self::SetDirtyFlag();
}
$_SESSION['LEMsid'] = $sid;
}
}
/**
* Sets the language for Expression Manager. If the language has changed, then EM cache must be invalidated and refreshed
* @param <string> $lang
*/
public static function SetEMLanguage($lang=NULL)
{
if (is_null($lang)) {
return; // should never happen
}
if (!isset($_SESSION['LEMlang'])) {
$_SESSION['LEMlang'] = $lang;
}
if ($_SESSION['LEMlang'] != $lang) {
// then changing languages, so clear cache
self::SetDirtyFlag();
}
$_SESSION['LEMlang'] = $lang;
}
/**
* Do bulk-update/save of Condition to Relevance
* @param <integer> $surveyId - if NULL, processes the entire database, otherwise just the specified survey
* @param <integer> $qid - if specified, just updates that one question
* @return array of query strings
*/
public static function UpgradeConditionsToRelevance($surveyId=NULL, $qid=NULL)
{
LimeExpressionManager::SetDirtyFlag(); // set dirty flag even if not conditions, since must have had a DB change
// Cheat and upgrade question attributes here too.
self::UpgradeQuestionAttributes(true,$surveyId,$qid);
if (is_null($surveyId))
{
$sQuery='SELECT sid FROM {{surveys}}';
$aSurveyIDs = Yii::app()->db->createCommand($sQuery)->queryColumn();
}
else{
$aSurveyIDs=array($surveyId);
}
foreach ($aSurveyIDs as $surveyId ) {
// echo $surveyId.'<br>';flush();@ob_flush();
$releqns = self::ConvertConditionsToRelevance($surveyId,$qid);
foreach ($releqns as $key=>$value) {
$sQuery = "UPDATE {{questions}} SET relevance=".Yii::app()->db->quoteValue($value)." WHERE qid=".$key;
Yii::app()->db->createCommand($sQuery)->execute();
}
}
LimeExpressionManager::SetDirtyFlag();
}
/**
* This reverses UpgradeConditionsToRelevance(). It removes Relevance for questions that have Condition
* @param <integer> $surveyId
* @param <integer> $qid
*/
public static function RevertUpgradeConditionsToRelevance($surveyId=NULL, $qid=NULL)
{
LimeExpressionManager::SetDirtyFlag(); // set dirty flag even if not conditions, since must have had a DB change
$releqns = self::ConvertConditionsToRelevance($surveyId,$qid);
$num = count($releqns);
if ($num == 0) {
return NULL;
}
foreach ($releqns as $key=>$value) {
$query = "UPDATE {{questions}} SET relevance=1 WHERE qid=".$key;
dbExecuteAssoc($query);
}
return count($releqns);
}
/**
* Return array database name as key, LEM name as value
* @example (['gender'] => '38612X10X145')
* @param <integer> $surveyId
**/
public static function getLEMqcode2sgqa($iSurveyId){
$LEM =& LimeExpressionManager::singleton();
$LEM->SetEMLanguage(Survey::model()->findByPk($iSurveyId)->language);
$LEM->SetSurveyId($iSurveyId);
$LEM->StartProcessingPage(true,true);
return $LEM->qcode2sgqa;
}
/**
* If $qid is set, returns the relevance equation generated from conditions (or NULL if there are no conditions for that $qid)
* If $qid is NULL, returns an array of relevance equations generated from Condition, keyed on the question ID
* @param <integer> $surveyId
* @param <integer> $qid - if passed, only generates relevance equation for that question - otherwise genereates for all questions with conditions
* @return array of generated relevance strings, indexed by $qid
*/
public static function ConvertConditionsToRelevance($surveyId=NULL, $qid=NULL)
{
$query = LimeExpressionManager::getConditionsForEM($surveyId,$qid);
$_qid = -1;
$relevanceEqns = array();
$scenarios = array();
$relAndList = array();
$relOrList = array();
foreach($query->readAll() as $row)
{
$row['method']=trim($row['method']); //For Postgres
if ($row['qid'] != $_qid)
{
// output the values for prior question is there was one
if ($_qid != -1)
{
if (count($relOrList) > 0)
{
$relAndList[] = '(' . implode(' or ', $relOrList) . ')';
}
if (count($relAndList) > 0)
{
$scenarios[] = '(' . implode(' and ', $relAndList) . ')';
}
$relevanceEqn = implode(' or ', $scenarios);
$relevanceEqns[$_qid] = $relevanceEqn;
}
// clear for next question
$_qid = $row['qid'];
$_scenario = $row['scenario'];
$_cqid = $row['cqid'];
$_subqid = -1;
$relAndList = array();
$relOrList = array();
$scenarios = array();
$releqn = '';
}
if ($row['scenario'] != $_scenario)
{
if (count($relOrList) > 0)
{
$relAndList[] = '(' . implode(' or ', $relOrList) . ')';
}
$scenarios[] = '(' . implode(' and ', $relAndList) . ')';
$relAndList = array();
$relOrList = array();
$_scenario = $row['scenario'];
$_cqid = $row['cqid'];
$_subqid = -1;
}
if ($row['cqid'] != $_cqid)
{
$relAndList[] = '(' . implode(' or ', $relOrList) . ')';
$relOrList = array();
$_cqid = $row['cqid'];
$_subqid = -1;
}
// fix fieldnames
if ($row['type'] == '' && preg_match('/^{.+}$/',$row['cfieldname'])) {
$fieldname = substr($row['cfieldname'],1,-1); // {TOKEN:xxxx}
$subqid = $fieldname;
$value = $row['value'];
}
else if ($row['type'] == 'M' || $row['type'] == 'P') {
if (substr($row['cfieldname'],0,1) == '+') {
// if prefixed with +, then a fully resolved name
$fieldname = substr($row['cfieldname'],1) . '.NAOK';
$subqid = $fieldname;
$value = $row['value'];
}
else {
// else create name by concatenating two parts together
$fieldname = $row['cfieldname'] . $row['value'] . '.NAOK';
$subqid = $row['cfieldname'];
$value = 'Y';
}
}
else {
$fieldname = $row['cfieldname'] . '.NAOK';
$subqid = $fieldname;
$value = $row['value'];
}
if ($_subqid != -1 && $_subqid != $subqid)
{
$relAndList[] = '(' . implode(' or ', $relOrList) . ')';
$relOrList = array();
}
$_subqid = $subqid;
// fix values
if (preg_match('/^@\d+X\d+X\d+.*@$/',$value)) {
$value = substr($value,1,-1);
}
else if (preg_match('/^{.+}$/',$value)) {
$value = substr($value,1,-1);
}
else if ($row['method'] == 'RX') {
if (!preg_match('#^/.*/$#',$value))
{
$value = '"/' . $value . '/"'; // if not surrounded by slashes, add them.
}
}
else {
$value = '"' . $value . '"';
}
// add equation
if ($row['method'] == 'RX')
{
$relOrList[] = "regexMatch(" . $value . "," . $fieldname . ")";
}
else
{
// Condition uses ' ' to mean not answered, but internally it is really stored as ''. Fix this
if ($value === '" "' || $value == '""') {
if ($row['method'] == '==')
{
$relOrList[] = "is_empty(" . $fieldname . ")";
}
else if ($row['method'] == '!=')
{
$relOrList[] = "!is_empty(" . $fieldname . ")";
}
else
{
$relOrList[] = $fieldname . " " . $row['method'] . " " . $value;
}
}
else
{
if ($value == '"0"' || !preg_match('/^".+"$/',$value))
{
switch ($row['method'])
{
case '==':
case '<':
case '<=':
case '>=':
$relOrList[] = '(!is_empty(' . $fieldname . ') && (' . $fieldname . " " . $row['method'] . " " . $value . '))';
break;
case '!=':
$relOrList[] = '(is_empty(' . $fieldname . ') || (' . $fieldname . " != " . $value . '))';
break;
default:
$relOrList[] = $fieldname . " " . $row['method'] . " " . $value;
break;
}
}
else
{
switch ($row['method'])
{
case '<':
case '<=':
$relOrList[] = '(!is_empty(' . $fieldname . ') && (' . $fieldname . " " . $row['method'] . " " . $value . '))';
break;
default:
$relOrList[] = $fieldname . " " . $row['method'] . " " . $value;
break;
}
}
}
}
if (($row['cqid'] == 0 && !preg_match('/^{TOKEN:([^}]*)}$/',$row['cfieldname'])) || substr($row['cfieldname'],0,1) == '+') {
$_cqid = -1; // forces this statement to be ANDed instead of being part of a cqid OR group (except for TOKEN fields)
}
}
// output last one
if ($_qid != -1)
{
if (count($relOrList) > 0)
{
$relAndList[] = '(' . implode(' or ', $relOrList) . ')';
}