LimeSurvey API - Master branch

LimeExpressionManager
in package

Application

Properties

$alias2varName : array<string|int, mixed>: array of mappings of knownVar aliases to the JavaScript variable names.
$allOnOnePage : bool: internally set to true (1) for survey.php so get group-specific logging but keep javascript variable namings consistent on the page.
$currentGroupSeq : int: current Group sequence (0-based index)
$currentQID : int: used in Question-by-Question mode
$currentQset : array<string|int, mixed>|null: set of the current set of questions to be displayed, indexed by QID - at least one must be relevant
$currentQuestionSeq : int: for Question-by-Question mode, the 0-based index
$debugLevel : int: sum of LEM_DEBUG constants - use bitwise AND comparisons to identify which parts to use
$debugTimingMsg : string: Message generated to show debug timing values, if debugLevel includes LEM_DEBUG_TIMING
$em : ExpressionManager: Implements the recursive descent parser that processes expressions
$gRelInfo : array<string|int, mixed>: array of Group-level relevance status Indexed by gseq; only shows groups that have been visited
$groupId2groupSeq : array<string|int, mixed>: map of gid to 0-based sequence number of groups
$groupRelevanceInfo : array<string|int, mixed>
$groupSeqInfo : array<string|int, mixed>: array of info about each Group, indexed by GroupSeq
$gseq2info : array<string|int, mixed>: array of group sequence number to static info One entry per group, indexed on gseq
$gseq2relevanceStatus : array<string|int, mixed>: tracks which groups have at least one relevant, non-hidden question
$indexGseq : array<string|int, mixed>: array of information needed to generate navigation index in group-by-group mode One entry for each group, indexed by gseq
$indexQseq : array<string|int, mixed>: array of information needed to generate navigation index in question-by-question mode One entry for each question, indexed by qseq
$initialized : bool: 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
$instance : LimeExpressionManager: LimeExpressionManager is a singleton. $instance is its storage location.
$invalidAnswerString : array<string|int, string>: Array of invalid answer, key is sgq, value is the clear string to be shown Must be always unset after using (EM are in $_SESSION and never new ....)
$jsVar2qid : array<string|int, mixed>: array of mappings of JavaScript Variable names to Question number (qid)
$knownVars : array<string|int, mixed>: Collection of variable attributes, indexed by SGQA code
$lastMoveResult : array<string|int, mixed>|null: last result of NavigateForwards, NavigateBackwards, or JumpTo Array of status information about last movement, whether at question, group, or survey level
$maxGroupSeq : int: the maximum groupSeq reached - this is needed for Index
$maxQuestionSeq : int: the maximum Question reached sequencly ordered, used to show error to the user if we stop before this step with indexed survey.
$multiflexiAnswers : array<string|int, mixed>: array of 2nd scale answer lists for types ':' and ';' -- needed for convenient print of logic file Indexed on qid; available for all questions
$numGroups : int: Number of groups in survey (number of possible pages to display)
$numQuestions : int: Number of questions in survey (counting display-only ones?)
$pageRelevanceInfo : array<string|int, mixed>: Array of relevance information for each page (gseq), indexed by gseq.
$pageTailorInfo : array<string|int, mixed>|null
$ParseResultCache : array<string|int, mixed>: temporary variable to reduce need to parse same equation multiple times. Used for relevance and validation Array, indexed on equation, providing the following information:
$processedRelevance : bool: True (1) if have already processed the relevance equations (so don't need to do it again)
$q2subqInfo : array<string|int, mixed>: /** mapping of questions to information about their subquestions.
$qans : array<string|int, mixed>: array of enumerated answer lists indexed by qid These use a tilde syntax to indicate which scale the answer is part of.
$qattr : array<string|int, mixed>: array of advanced question attributes for each question Indexed by qid; available for all quetions
$qcode2sgq : array<string|int, mixed>: maps name of the variable to the SGQ name (without the A suffix)
$qcode2sgqa : array<string|int, mixed>|null: maps qcode varname to SGQA code
$qid2code : array<string|int, mixed>: array of mappings of Question # (qid) to pipe-delimited list of SGQA codes used within it
$qid2exclusiveAuto : array<string|int, mixed>: Array, keyed on qid, to JavaScript and list of variables needed to implement exclude_all_others_auto
$qid2validationEqn : array<string|int, mixed>: maps question # to the validation equation(s) for that question.
$qrootVarName2arrayFilter : array<string|int, mixed>: Linked list of array filters
$questionId2groupSeq : array<string|int, mixed>: map question # to the group it is within, using an incremental count of group order
$questionId2questionSeq : array<string|int, mixed>: map question # to an incremental count of question order across the whole survey
$questionSeq2relevance : array<string|int, mixed>: 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
$runtimeTimings : array<string|int, mixed>: Array of timing information to debug how long it takes for portions of LEM to run.
$sessid : string: String identifier for the active session
$sgqaNaming : bool: 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
$sid : int: The survey ID
$sPreviewMode : string|false: sPreviewMode used for relevance equation and to disable save value in DB 'question' or 'group' string force relevance to 1 if needed
$subQrelInfo : array<string|int, mixed>: list of needed subquestion relevance (e.g. array_filter) Indexed by qid then sgqa; only generated for current group of questions
$surveyMode : string: survey mode. One of 'survey', 'group', or 'question'
$surveyOptions : array<string|int, mixed>: a set of global survey options passed from LimeSurvey
$tempVars : array<string|int, mixed>: variables temporarily set for substitution purposes temporarily mean for this page, until reset. Not for next page
$updatedValues : array<string|int, mixed>: Array of values to be updated
$varNameAttr : array<string|int, mixed>: JavaScript array of mappings of canonical JavaScript variable name to key attributes.

Methods

__clone() : mixed: Prevent users to clone the instance
_CreateSubQLevelRelevanceAndValidationEqns() : void: Process all question attributes that apply to EM (1) subquestion-level relevance: e.g. array_filter, array_filter_exclude, relevance equations entered in SQ-mask (2) Validations: e.g. min/max number of answers; min/max/eq sum of answers
_ValidateGroup() : array<string|int, mixed>: Check a group and all of the questions it contains
_ValidateQuestion() : array<string|int, mixed>: For the current set of questions (whether in survey, gtoup, or question-by-question mode), assesses the following: (a) mandatory - if so, then all relevant subquestions must be answered (e.g. pay attention to array_filter and array_filter_exclude) (b) always-hidden (c) relevance status - including subquestion-level relevance (d) answered - if $_SESSION[$LEM->sessid][sgqa]=='' or NULL, then it is not answered (e) validity - whether relevant questions pass their validity tests
addFrontendFlashMessage() : void: Add a flash message to state-key 'frontend{survey ID}' The flash messages are templatereplaced in startpage.tstpl, {FLASHMESSAGE}
addValidityString() : void: Set or log an invalid answer string
ConvertConditionsToRelevance() : array<string|int, mixed>: 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
convertNonLatinNumerics() : string: Convert non-latin numerics in string to latin numerics Used for datepicker (Hindi, Arabic numbers)
FinishProcessingGroup() : void: Should be called after each group finishes
FinishProcessingPage() : void: Should be called at end of each page
FinishProcessPublicPage() : string|null: End public HTML
GetAllVarNamesForQ() : string: Expand "self.suffix" and "that.qcode.suffix" into canonical list of variable names
getAnswerSetsForEM() : array<string|int, mixed>: Return array of language-specific answer codes
GetDebugTimingMessage() : string: Return a formatted table showing how much time each part of EM consumed
getEMlanguage() : string: Get the current public language
GetGroupIndexInfo() : array<string|int, mixed>: Get array of info needed to display the Group Index
getGroupInfoForEM() : array<string|int, mixed>: Returns group info needed for indexes
GetGroupSeq() : int: Translate GID to 0-index Group Sequence number
GetLastMoveResult() : array<string|int, mixed>|null: Get last move information, optionally clearing the substitution cache
GetLastPrettyPrintExpression() : string: Used to show potential syntax errors of processing Relevance or Equations.
getLEMqcode2sgqa() : array<string|int, mixed>: Return array database name as key, LEM name as value
getLEMsurveyId() : int: Returns the survey ID of the EM singleton
GetQuestionIndexInfo() : array<string|int, mixed>: Get array of info needed to display the Question Index
GetQuestionSeq() : int: Get question sequence number from QID
GetQuestionStatus() : mixed
getRegexpValidAttributes() : string: Return the regexp used to check if suffix is valid
GetRelevanceAndTailoringJavaScript() : mixed
GetStepIndexInfo() : array<string|int, mixed>: Return entries needed to build the navigation index
getUpdatedValues() : array<string|int, mixed>
GetVarAttribute() : mixed
GroupIsIrrelevantOrHidden() : bool: Return whether group $gseq is relevant
GroupIsRelevant() : bool: Returns true if the group is relevant and should be shown
htmlSpecialCharsUserValue() : string: return a value entered by user to be shown or used in expression
isInitialized() : bool: Did LEM is currently initialized
isValidVariable() : mixed
JumpTo() : array<string|int, mixed>: Jump to a specific question or group sequence. If jumping forward, it re-validates everything in between
loadTokenInformation() : void: This function loads the relevant data about tokens for a survey.
NavigateBackwards() : array<string|int, mixed>: Move the current survey position one step backward (according to survey/group/question mode) and prepare navigation state.
NavigateForwards() : array<string|int, mixed>|null: Advance the survey flow one step (question/group/survey) according to the current survey mode and validation outcomes.
ProcessAllNeededRelevance() : void: Check the relevance status of all questions on or before the current group.
ProcessCurrentResponses() : mixed: Cleanse the $_POSTed data and update $_SESSION variables accordingly
ProcessRelevance() : bool: Compute Relevance, processing $eqn to get a boolean value. If there are syntax errors, return false.
ProcessStepString() : string: Translate all Expressions, Macros, registered variables, etc. in $string for current step
ProcessString() : string: Translate all Expressions, Macros, registered variables, etc. in $string
QuestionIsRelevant() : bool: Return whether question $qid is relevanct
resetTempVars() : mixed: Reset the current temporary variable replacement Done automatically when page start or page finish ( @param array $vars
RevertUpgradeConditionsToRelevance() : int: This reverses UpgradeConditionsToRelevance(). It removes Relevance for questions that have Condition
setCurrentQset() : void: Set currentQset. Used by unit-tests.
SetDirtyFlag() : void: Tells ExpressionScript Engine that something has changed enough that needs to eliminate internal caching
SetEMLanguage() : void: Sets the language for ExpressionScript Engine. If the language has changed, then EM cache must be invalidated and refreshed
setKnownVars() : void: Used for unit tests.
setPageRelevanceInfo() : void: Used for unit tests.
SetPreviewMode() : void: Set the previewmode
SetRelevanceTo() : void: Set the relevance status to the $step
SetSurveyId() : mixed: Set the SurveyId - really checks whether the survey you're about to work with is new, and if so, clears the LEM cache
setTempVars() : mixed
SetThisAsAliasForSGQA() : void: Set the 'this' variable as an alias for SGQA within the code.
setValueToKnowVar() : mixed: Helper function to update a Read only value
setVariableAndTokenMappingsForExpressionManager() : bool: Build and cache variable and token mappings used by the ExpressionManager for a survey.
SetVariableValue() : int
ShowStackTrace() : mixed
ShowSurveyLogicFile() : array<string|int, mixed>: Render an HTML "logic file" that lists all expressions, relevances, validations, defaults, subquestions, and answer texts for a survey (or a specific group/question) and reports syntax errors and warnings.
singleton() : LimeExpressionManager: Ensures there is only one instances of LEM. Note, if switch between surveys, have to clear this cache
SplitStringOnExpressions() : array<string|int, mixed>: Returns an array of string parts, splitting out expressions
StartProcessingGroup() : void: This should be called each time a new group is started, whether on same or different pages. Sets/Clears needed internal parameters.
StartProcessingPage() : void: Should be first function called on each page - sets/clears internally needed variables
StartSurvey() : array<string|int, mixed>: Initialize a survey so can use EM to manage navigation
SubQuestionIsRelevant() : bool: Return whether a subquestion is relevant
UnitTestConvertConditionsToRelevance() : array<string|int, mixed>: Return list of relevance equations generated from conditions
UnitTestProcessStringContainingExpressions() : mixed: Unit test strings containing expressions
UnitTestRelevance() : mixed: Unit test Relevance using a simplified syntax to represent questions.
updateReplacementFields() : mixed: Add or replace fixed variable replacement for current page (or until self::resetTempVars was called)
UpgradeConditionsToRelevance() : array<string|int, mixed>: Do bulk-update/save of Condition to Relevance
UpgradeQuestionAttributes() : mixed: Deprecate obsolete question attributes.
usingCommaAsRadix() : bool: Returns true if the survey is using comma as the radix
__construct() : mixed: A private constructor; prevents direct creation of object
_GetVarAttribute() : mixed
_ProcessGroupRelevance() : void
_ProcessRelevance() : bool: Compute Relevance, processing $eqn to get a boolean value. If there are syntax errors, return false.
_ProcessSubQRelevance() : bool: Create JavaScript needed to process subquestion-level relevance (e.g. for array_filter and _exclude)
_recursivelyFindAntecdentArrayFilters() : array<string|int, mixed>: Collects all antecedent `array_filter` and `array_filter_exclude` roots that precede a given qroot.
_UpdateValuesInDatabase() : string: Write values to database.
_ValidateSurvey() : array<string|int, mixed>: Check the entire survey
checkValidityAnswer() : bool: Check a validity of an answer, Put the string to show to user $this->invalidAnswerString See mantis #10827, #11611 and #14649
getConditionsForEM() : mixed
getQuestionAttributesForEM() : array<string|int, mixed>: Return array of language-specific answer codes
getValidityString() : string|null: return the actual validity string , and reset the variable used ($_SESSION)
gT() : mixed
ngT() : mixed
resolveOtherJsVarNameOn() : string: Resolve the on-page JS variable name for a field that may be an "other" text input.
throwFatalError() : mixed: Kills the survey session and throws an exception with the specified message.

$alias2varName

array of mappings of knownVar aliases to the JavaScript variable names.


    private
        array<string|int, mixed>
    $alias2varName

This maps both the SGQA and qcode alias names to the same 2 dimensional array

$allOnOnePage

internally set to true (1) for survey.php so get group-specific logging but keep javascript variable namings consistent on the page.


    private
        bool
    $allOnOnePage
     = \false

$currentGroupSeq

current Group sequence (0-based index)


    private
        int
    $currentGroupSeq

$currentQID

used in Question-by-Question mode


    private
        int
    $currentQID

$currentQset

set of the current set of questions to be displayed, indexed by QID - at least one must be relevant


    private
        array<string|int, mixed>|null
    $currentQset
     = \null

The array has N entries, where N is the number if qids in the Qset. Each has the following contents:

$currentQuestionSeq

for Question-by-Question mode, the 0-based index


    private
        int
    $currentQuestionSeq

$debugLevel

sum of LEM_DEBUG constants - use bitwise AND comparisons to identify which parts to use


    private
        int
    $debugLevel
     = 0

$debugTimingMsg

Message generated to show debug timing values, if debugLevel includes LEM_DEBUG_TIMING


    private
        string
    $debugTimingMsg
     = ''

$em

Implements the recursive descent parser that processes expressions


    private
        ExpressionManager
    $em

$gRelInfo

array of Group-level relevance status Indexed by gseq; only shows groups that have been visited


    private
        array<string|int, mixed>
    $gRelInfo
     = []

$groupId2groupSeq

map of gid to 0-based sequence number of groups


    private
        array<string|int, mixed>
    $groupId2groupSeq

$groupRelevanceInfo


    private
        array<string|int, mixed>
    $groupRelevanceInfo

$groupSeqInfo

array of info about each Group, indexed by GroupSeq


    private
        array<string|int, mixed>
    $groupSeqInfo

$gseq2info

array of group sequence number to static info One entry per group, indexed on gseq


    private
        array<string|int, mixed>
    $gseq2info

$gseq2relevanceStatus

tracks which groups have at least one relevant, non-hidden question


    private
        array<string|int, mixed>
    $gseq2relevanceStatus

$indexGseq

array of information needed to generate navigation index in group-by-group mode One entry for each group, indexed by gseq


    private
        array<string|int, mixed>
    $indexGseq

$indexQseq

array of information needed to generate navigation index in question-by-question mode One entry for each question, indexed by qseq


    private
        array<string|int, mixed>
    $indexQseq

$initialized

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


    private
        bool
    $initialized
     = \false

$instance

LimeExpressionManager is a singleton. $instance is its storage location.


    private
    static    LimeExpressionManager
    $instance

$invalidAnswerString

Array of invalid answer, key is sgq, value is the clear string to be shown Must be always unset after using (EM are in $_SESSION and never new ....)


    private
        array<string|int, string>
    $invalidAnswerString
     = []

$jsVar2qid

array of mappings of JavaScript Variable names to Question number (qid)


    private
        array<string|int, mixed>
    $jsVar2qid

$knownVars

Collection of variable attributes, indexed by SGQA code


    private
        array<string|int, mixed>
    $knownVars
     = []

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 subquestion) '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 subquestion) '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 subquestion or answer-level suffix. This is from the title column in the questions table 'subqtext' => // the subquestion 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 );

$lastMoveResult

last result of NavigateForwards, NavigateBackwards, or JumpTo Array of status information about last movement, whether at question, group, or survey level


    private
        array<string|int, mixed>|null
    $lastMoveResult
     = \null

$maxGroupSeq

the maximum groupSeq reached - this is needed for Index


    private
        int
    $maxGroupSeq

$maxQuestionSeq

the maximum Question reached sequencly ordered, used to show error to the user if we stop before this step with indexed survey.


    private
        int
    $maxQuestionSeq
     = -1

In question by question mode : $maxQuestionSeq==$SESSION['responses'.surveyid]['maxstep'], use it ?

$multiflexiAnswers

array of 2nd scale answer lists for types ':' and ';' -- needed for convenient print of logic file Indexed on qid; available for all questions


    private
        array<string|int, mixed>
    $multiflexiAnswers

$numGroups

Number of groups in survey (number of possible pages to display)


    private
        int
    $numGroups
     = 0

$numQuestions

Number of questions in survey (counting display-only ones?)


    private
        int
    $numQuestions
     = 0

$pageRelevanceInfo

Array of relevance information for each page (gseq), indexed by gseq.


    private
        array<string|int, mixed>
    $pageRelevanceInfo

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

$pageTailorInfo


    private
        array<string|int, mixed>|null
    $pageTailorInfo

Array of array of information about HTML id to update with javascript function [[ 'questionNum' : question number 'num' : internal number of javascript function 'id' : id of HTML element 'raw' : Raw Expression 'result' : 'vars' : var used in javascript function 'js' : final javascript function ]]

$ParseResultCache

temporary variable to reduce need to parse same equation multiple times. Used for relevance and validation Array, indexed on equation, providing the following information:


    private
        array<string|int, mixed>
    $ParseResultCache

$processedRelevance

True (1) if have already processed the relevance equations (so don't need to do it again)


    private
        bool
    $processedRelevance
     = \false

$q2subqInfo

/** mapping of questions to information about their subquestions.


    private
        array<string|int, mixed>
    $q2subqInfo

One entry per question, indexed on qid

$qans

array of enumerated answer lists indexed by qid These use a tilde syntax to indicate which scale the answer is part of.


    private
        array<string|int, mixed>
    $qans

$qattr

array of advanced question attributes for each question Indexed by qid; available for all quetions


    private
        array<string|int, mixed>
    $qattr

$qcode2sgq

maps name of the variable to the SGQ name (without the A suffix)


    private
        array<string|int, mixed>
    $qcode2sgq

$qcode2sgqa

maps qcode varname to SGQA code


    private
        array<string|int, mixed>|null
    $qcode2sgqa

$qid2code

array of mappings of Question # (qid) to pipe-delimited list of SGQA codes used within it


    private
        array<string|int, mixed>
    $qid2code

$qid2exclusiveAuto

Array, keyed on qid, to JavaScript and list of variables needed to implement exclude_all_others_auto


    private
        array<string|int, mixed>
    $qid2exclusiveAuto
     = []

$qid2validationEqn

maps question # to the validation equation(s) for that question.


    private
        array<string|int, mixed>
    $qid2validationEqn

These are grouped by qid then validation type, such as 'value_range', and 'num_answers'

$qrootVarName2arrayFilter

Linked list of array filters


    private
        array<string|int, mixed>
    $qrootVarName2arrayFilter
     = []

$questionId2groupSeq

map question # to the group it is within, using an incremental count of group order


    private
        array<string|int, mixed>
    $questionId2groupSeq

$questionId2questionSeq

map question # to an incremental count of question order across the whole survey


    private
        array<string|int, mixed>
    $questionId2questionSeq

$questionSeq2relevance

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


    private
        array<string|int, mixed>
    $questionSeq2relevance

$runtimeTimings

Array of timing information to debug how long it takes for portions of LEM to run.


    private
        array<string|int, mixed>
    $runtimeTimings
     = []

Array of timing information (in seconds) for EM to help with debugging

$sessid

String identifier for the active session


    private
        string
    $sessid

$sgqaNaming

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


    private
        bool
    $sgqaNaming
     = \true

$sid

The survey ID


    private
        int
    $sid

$sPreviewMode

sPreviewMode used for relevance equation and to disable save value in DB 'question' or 'group' string force relevance to 1 if needed


    private
        string|false
    $sPreviewMode
     = \false

$subQrelInfo

list of needed subquestion relevance (e.g. array_filter) Indexed by qid then sgqa; only generated for current group of questions


    private
        array<string|int, mixed>
    $subQrelInfo
     = []

$surveyMode

survey mode. One of 'survey', 'group', or 'question'


    private
        string
    $surveyMode
     = 'group'

$surveyOptions

a set of global survey options passed from LimeSurvey


    private
        array<string|int, mixed>
    $surveyOptions
     = []

For example, array( 'rooturl' => // URL prefix needed to be able to click on a syntax-highlighted variable name and have it open the needed editing 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_responses_38612 'target' => // the path for uploading files -- e.g. '/temp/files/' 'timeadjust' => // The time zone offset in hours -- e.g. 0 'displayTimezone' => // The timezone -- e.g. 'Europe/Berlin'

'tempdir' => // the temporary directory for uploading files -- e.g. '/temp/' );

$tempVars

variables temporarily set for substitution purposes temporarily mean for this page, until reset. Not for next page


    private
        array<string|int, mixed>
    $tempVars
     = []

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' );

$updatedValues

Array of values to be updated


    private
        array<string|int, mixed>
    $updatedValues
     = []

$varNameAttr

JavaScript array of mappings of canonical JavaScript variable name to key attributes.


    private
        array<string|int, mixed>
    $varNameAttr

These fragments are used to create the JavaScript varNameAttr array.

__clone()

Prevent users to clone the instance


    public
                    __clone() : mixed

_CreateSubQLevelRelevanceAndValidationEqns()

Process all question attributes that apply to EM (1) subquestion-level relevance: e.g. array_filter, array_filter_exclude, relevance equations entered in SQ-mask (2) Validations: e.g. min/max number of answers; min/max/eq sum of answers


    public
                    _CreateSubQLevelRelevanceAndValidationEqns([int|null $onlyThisQseq = null ]) : void

Parameters

$onlyThisQseq : int|null = null

only process these attributes for the specified question

_ValidateGroup()

Check a group and all of the questions it contains


    public
                    _ValidateGroup(int $groupSeq[, bool $force = false ]) : array<string|int, mixed>

Parameters

$groupSeq : int

the index-0 sequence number for this group

$force : bool = false

: force validation to true, even if there are error

Return values

array<string|int, mixed> —

Detailed information about this group

_ValidateQuestion()

For the current set of questions (whether in survey, gtoup, or question-by-question mode), assesses the following: (a) mandatory - if so, then all relevant subquestions must be answered (e.g. pay attention to array_filter and array_filter_exclude) (b) always-hidden (c) relevance status - including subquestion-level relevance (d) answered - if $_SESSION[$LEM->sessid][sgqa]=='' or NULL, then it is not answered (e) validity - whether relevant questions pass their validity tests


    public
                    _ValidateQuestion(int $questionSeq[, bool $force = false ]) : array<string|int, mixed>

Parameters

$questionSeq : int

the 0-index sequence number for this question

$force : bool = false

: force validation to true, even if there are error, this allow to save in DB even with error

Return values

array<string|int, mixed> —

Array of information about this question and its subquestions

addFrontendFlashMessage()

Add a flash message to state-key 'frontend{survey ID}' The flash messages are templatereplaced in startpage.tstpl, {FLASHMESSAGE}


    public
            static        addFrontendFlashMessage(string $type, string $message, int $surveyid) : void

Parameters

$type : string: Yii type of flash: error, notice, 'success'
$message : string
$surveyid : int

addValidityString()

Set or log an invalid answer string


    public
                    addValidityString(string $sgqa, mixed $value, string $message[, bool $add = true ]) : void

Parameters

$sgqa : string: : the SGQ (answer column / SGQA)
$value : mixed
$message : string: : the message
$add : bool = true: : add it to current validity or only og it

ConvertConditionsToRelevance()

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


    public
            static        ConvertConditionsToRelevance(int $surveyId[, int|null $qid = null ]) : array<string|int, mixed>

Parameters

$surveyId : int

$qid : int|null = null

if passed, only generates relevance equation for that question - otherwise generates for all questions with conditions

Return values

array<string|int, mixed> —

of generated relevance strings, indexed by $qid

convertNonLatinNumerics()

Convert non-latin numerics in string to latin numerics Used for datepicker (Hindi, Arabic numbers)


    public
            static        convertNonLatinNumerics(string $str, string $lang) : string

Parameters

$str : string
$lang : string

Return values

string

FinishProcessingGroup()

Should be called after each group finishes


    public
            static        FinishProcessingGroup([bool|null $skipReprocessing = false ]) : void

Parameters

$skipReprocessing : bool|null = false

FinishProcessingPage()

Should be called at end of each page


    public
            static        FinishProcessingPage() : void

FinishProcessPublicPage()

End public HTML


    public
            static        FinishProcessPublicPage([mixed $applyJavaScriptAnyway = false ]) : string|null

Parameters

$applyJavaScriptAnyway : mixed = false

Return values

string|null —

: hidden inputs needed for relevance

GetAllVarNamesForQ()

Expand "self.suffix" and "that.qcode.suffix" into canonical list of variable names


    public
            static        GetAllVarNamesForQ(int $qseq, string $varname) : string

Parameters

$qseq : int
$varname : string

Return values

string

getAnswerSetsForEM()

Return array of language-specific answer codes


    public
                    getAnswerSetsForEM([int|null $surveyid = null ][, string|null $lang = null ]) : array<string|int, mixed>

Parameters

$surveyid : int|null = null
$lang : string|null = null

Return values

array<string|int, mixed>

GetDebugTimingMessage()

Return a formatted table showing how much time each part of EM consumed


    public
            static        GetDebugTimingMessage() : string

Return values

string

getEMlanguage()

Get the current public language


    public
            static        getEMlanguage() : string

Return values

string

GetGroupIndexInfo()

Get array of info needed to display the Group Index


    public
            static        GetGroupIndexInfo([string $gseq = null ]) : array<string|int, mixed>

Parameters

$gseq : string = null

Return values

array<string|int, mixed>

getGroupInfoForEM()

Returns group info needed for indexes


    public
                    getGroupInfoForEM(int $surveyid[, string|null $sLanguage = null ]) : array<string|int, mixed>

Parameters

$surveyid : int
$sLanguage : string|null = null

Return values

array<string|int, mixed>

GetGroupSeq()

Translate GID to 0-index Group Sequence number


    public
            static        GetGroupSeq(int $gid) : int

Parameters

$gid : int

Return values

int

GetLastMoveResult()

Get last move information, optionally clearing the substitution cache


    public
            static        GetLastMoveResult([bool $clearSubstitutionInfo = false ]) : array<string|int, mixed>|null

Parameters

$clearSubstitutionInfo : bool = false

Return values

array<string|int, mixed>|null

GetLastPrettyPrintExpression()

Used to show potential syntax errors of processing Relevance or Equations.


    public
            static        GetLastPrettyPrintExpression() : string

Return values

string

getLEMqcode2sgqa()

Return array database name as key, LEM name as value


    public
            static        getLEMqcode2sgqa(int $iSurveyId) : array<string|int, mixed>

Parameters

$iSurveyId : int

Return values

array<string|int, mixed> —

*@example (['gender'] => '38612X10X145')

getLEMsurveyId()

Returns the survey ID of the EM singleton


    public
            static        getLEMsurveyId() : int

Return values

int

GetQuestionIndexInfo()

Get array of info needed to display the Question Index


    public
            static        GetQuestionIndexInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

GetQuestionSeq()

Get question sequence number from QID


    public
            static        GetQuestionSeq(int $qid) : int

Parameters

$qid : int

Return values

int

GetQuestionStatus()


    public
            static        GetQuestionStatus(mixed $qid) : mixed

Parameters

$qid : mixed

getRegexpValidAttributes()

Return the regexp used to check if suffix is valid


    public
            static        getRegexpValidAttributes() : string

Return values

string

GetRelevanceAndTailoringJavaScript()


    public
            static        GetRelevanceAndTailoringJavaScript([mixed $bReturnArray = false ]) : mixed

Parameters

$bReturnArray : mixed = false

GetStepIndexInfo()

Return entries needed to build the navigation index


    public
            static        GetStepIndexInfo([int|null $step = null ]) : array<string|int, mixed>

Parameters

$step : int|null = null

if specified, return a single value, otherwise return entire array

Return values

array<string|int, mixed> —

will be either question or group-level, depending upon $surveyMode

getUpdatedValues()


    public
                    getUpdatedValues() : array<string|int, mixed>

Return values

array<string|int, mixed>

GetVarAttribute()


    public
            static        GetVarAttribute(mixed $name, string|null $attr, mixed $default, int $gseq, int $qseq) : mixed

Parameters

$name : mixed
$attr : string|null
$default : mixed
$gseq : int
$qseq : int

GroupIsIrrelevantOrHidden()

Return whether group $gseq is relevant


    public
            static        GroupIsIrrelevantOrHidden(int $gseq) : bool

Parameters

$gseq : int

Return values

bool

GroupIsRelevant()

Returns true if the group is relevant and should be shown


    public
            static        GroupIsRelevant(int $gid) : bool

Parameters

$gid : int

Return values

bool

htmlSpecialCharsUserValue()

return a value entered by user to be shown or used in expression


    public
            static        htmlSpecialCharsUserValue(string $string) : string

Parameters

$string : string

Return values

string

isInitialized()

Did LEM is currently initialized


    public
            static        isInitialized() : bool

Return values

bool

isValidVariable()


    public
            static        isValidVariable(mixed $varName) : mixed

Parameters

$varName : mixed

JumpTo()

Jump to a specific question or group sequence. If jumping forward, it re-validates everything in between


    public
            static        JumpTo(int $seq[, string|false $preview = false ][, bool $processPOST = true ][, bool $force = false ][, bool $changeLang = false ]) : array<string|int, mixed>

Parameters

$seq : int

the sequential step

$preview : string|false = false

@see var $sPreviewMode

$processPOST : bool = true

add the updated value to be saved in the database

$force : bool = false

if true, then skip validation of current group (e.g. will jump even if there are errors)

$changeLang : bool = false

Return values

array<string|int, mixed> —

$this->lastMoveResult

loadTokenInformation()

This function loads the relevant data about tokens for a survey.


    public
                    loadTokenInformation(int $iSurveyId[, string|null $sToken = null ][, bool|null $bAnonymize = false ]) : void

If specific token is not given it loads empty values, this is used for question previewing and the like.

Parameters

$iSurveyId : int
$sToken : string|null = null
$bAnonymize : bool|null = false

NavigateBackwards()

Move the current survey position one step backward (according to survey/group/question mode) and prepare navigation state.


    public
            static        NavigateBackwards() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An associative array with the navigation result. Common keys:

at_start (bool): true when the start of the survey was reached.
finished (bool): true when the survey is finished.
message (string): concatenated messages produced during validation/update.
unansweredSQs (mixed): list or count of unanswered subquestions, if available.
invalidSQs (mixed): list or count of invalid subquestions, if available. Mode-specific keys (present when applicable):
gseq, seq (int): group sequence to display next.
qseq, qseq/seq (int): question sequence to display next.
mandViolation (bool): whether a mandatory violation was detected on the target step.
mandSoft (bool): whether a soft-mandatory condition applies.
mandNonSoft (bool): whether a non-soft mandatory condition applies.
valid (bool): whether the target step is valid.
notRelevantSteps (int): number of skipped not-relevant steps.
hiddenSteps (int): number of skipped hidden steps.

NavigateForwards()

Advance the survey flow one step (question/group/survey) according to the current survey mode and validation outcomes.


    public
            static        NavigateForwards([bool $force = false ]) : array<string|int, mixed>|null

Processes posted responses for the current step, runs server-side validation (survey/group/question as appropriate), updates stored answers when required, and moves the internal pointers to the next visible/relevant step. If validation prevents advancing and $force is false, the current step is redisplayed and appropriate error/validation info is returned.

Parameters

$force : bool = false: If true, continue advancing even when mandatory or validity violations are present.

Return values

array<string|int, mixed>|null —

An associative array describing the navigation result and status, or null on failure. Common keys:

'finished' (bool): whether the survey has been completed.
'message' (string): concatenated validation/update messages for display.
'gseq','seq','qseq' (int): group/question/sequence indices for the new/current position (when applicable).
'mandViolation' (bool): whether a mandatory violation occurred.
'mandSoft' (bool): whether a soft mandatory violation occurred.
'mandNonSoft' (bool): whether a non-soft mandatory violation occurred.
'valid' (bool): whether the last-validated step passed validation.
'unansweredSQs' (mixed): list or representation of unanswered subquestions (when present).
'invalidSQs' (mixed): list or representation of invalid subquestions (when present).
'notRelevantSteps' (int): number of skipped non-relevant steps (question mode).
'hiddenSteps' (int): number of skipped hidden steps (question mode).

ProcessAllNeededRelevance()

Check the relevance status of all questions on or before the current group.


    public
                    ProcessAllNeededRelevance([string|null $onlyThisQseq = null ][, mixed $groupSeq = null ]) : void

This generates needed JavaScript for dynamic relevance, and sets flags about which questions and groups are relevant

Parameters

$onlyThisQseq : string|null = null
$groupSeq : mixed = null

ProcessCurrentResponses()

Cleanse the $_POSTed data and update $_SESSION variables accordingly


    public
            static        ProcessCurrentResponses() : mixed

ProcessRelevance()

Compute Relevance, processing $eqn to get a boolean value. If there are syntax errors, return false.


    public
            static        ProcessRelevance(string $eqn[, string $questionNum = null ][, string $jsResultVar = null ][, string $type = null ][, int $hidden = 0 ]) : bool

Parameters

$eqn : string

the relevance equation

$questionNum : string = null

needed to align question-level relevance and tailoring

$jsResultVar : string = null

this variable determines whether irrelevant questions are hidden

$type : string = null

question type

$hidden : int = 0

whether question should always be hidden

Return values

bool

ProcessStepString()

Translate all Expressions, Macros, registered variables, etc. in $string for current step


    public
            static        ProcessStepString(string|null $string[, array<string|int, mixed> $replacementFields = [] ][, int $numRecursionLevels = 3 ][, bool $static = false ]) : string

Parameters

$string : string|null

the string to be replaced

$replacementFields : array<string|int, mixed> = []

optional replacement values

$numRecursionLevels : int = 3

the number of times to recursively substitute values in this string

$static : bool = false

return static string (without any javascript)

Return values

string —

the original $string with all replacements done.

ProcessString()

Translate all Expressions, Macros, registered variables, etc. in $string


    public
            static        ProcessString(string|null $string[, int $questionNum = null ][, array<string|int, mixed>|null $replacementFields = [] ][, int $numRecursionLevels = 1 ][, int $whichPrettyPrintIteration = 1 ][, bool $noReplacements = false ][, bool $timeit = true ][, bool $staticReplacement = false ]) : string

Parameters

$string : string|null

the string to be replaced

$questionNum : int = null

the $qid of question being replaced - needed for properly alignment of question-level relevance and tailoring

$replacementFields : array<string|int, mixed>|null = []

optional replacement values

$numRecursionLevels : int = 1

the number of times to recursively substitute values in this string

$whichPrettyPrintIteration : int = 1

if want to pretty-print the source string, which recursion level should be pretty-printed

$noReplacements : bool = false

true if we already know that no replacements are needed (e.g. there are no curly braces)

$timeit : bool = true

$staticReplacement : bool = false

return HTML string without the system to update by javascript

Return values

string —

the original $string with all replacements done.

QuestionIsRelevant()

Return whether question $qid is relevanct


    public
            static        QuestionIsRelevant(int $qid) : bool

Parameters

$qid : int

Return values

bool

resetTempVars()

Reset the current temporary variable replacement Done automatically when page start or page finish ( @param array $vars


    public
            static        resetTempVars() : mixed

RevertUpgradeConditionsToRelevance()

This reverses UpgradeConditionsToRelevance(). It removes Relevance for questions that have Condition


    public
            static        RevertUpgradeConditionsToRelevance([int|null $surveyId = null ][, int|null $qid = null ]) : int

Parameters

$surveyId : int|null = null
$qid : int|null = null

Return values

int

setCurrentQset()

Set currentQset. Used by unit-tests.


    public
                    setCurrentQset(array<string|int, mixed> $val) : void

Parameters

$val : array<string|int, mixed>

SetDirtyFlag()

Tells ExpressionScript Engine that something has changed enough that needs to eliminate internal caching


    public
            static        SetDirtyFlag() : void

SetEMLanguage()

Sets the language for ExpressionScript Engine. If the language has changed, then EM cache must be invalidated and refreshed


    public
            static        SetEMLanguage([string|null $lang = null ]) : void

Parameters

$lang : string|null = null

setKnownVars()

Used for unit tests.


    public
                    setKnownVars(mixed $val) : void

Parameters

$val : mixed

setPageRelevanceInfo()

Used for unit tests.


    public
                    setPageRelevanceInfo(mixed $info) : void

Parameters

$info : mixed

SetPreviewMode()

Set the previewmode


    public
            static        SetPreviewMode([string|false $previewmode = false ]) : void

Parameters

$previewmode : string|false = false: 'question', 'group', false

SetRelevanceTo()

Set the relevance status to the $step


    public
            static        SetRelevanceTo(int $seq) : void

Parameters

$seq : int

the sequential step

SetSurveyId()

Set the SurveyId - really checks whether the survey you're about to work with is new, and if so, clears the LEM cache


    public
            static        SetSurveyId([int|null $sid = null ]) : mixed

Parameters

$sid : int|null = null

setTempVars()


    public
            static        setTempVars(array<string|int, mixed> $vars) : mixed

Parameters

$vars : array<string|int, mixed>

SetThisAsAliasForSGQA()

Set the 'this' variable as an alias for SGQA within the code.


    public
            static        SetThisAsAliasForSGQA(string $sgqa) : void

Parameters

$sgqa : string

setValueToKnowVar()

Helper function to update a Read only value


    public
            static        setValueToKnowVar(string $var, string $value) : mixed

Parameters

$var : string
$value : string

setVariableAndTokenMappingsForExpressionManager()

Build and cache variable and token mappings used by the ExpressionManager for a survey.


    public
                    setVariableAndTokenMappingsForExpressionManager(int $surveyid[, bool|null $forceRefresh = false ][, bool|null $anonymized = false ]) : bool

Populates internal maps (known variables, question/subquestion metadata, JS aliases, token fields, etc.) required for processing LimeSurvey expressions and for client-side relevance/validation logic. This operation is expensive; when not forced it will reuse existing cached mappings when possible.

Parameters

$surveyid : int: Survey primary key (sid) for which to build mappings.
$forceRefresh : bool|null = false: When true, force rebuilding mappings even if cached mappings exist.
$anonymized : bool|null = false: When true, token field values are populated as blank to preserve anonymity.

Return values

bool —

True if mappings were (re)created; false if existing cached mappings were reused or mappings could not be built.

SetVariableValue()


    public
            static        SetVariableValue(string $op, string $name, float $value) : int

Parameters

$op : string
$name : string
$value : float

Return values

int

ShowStackTrace()


    public
            static        ShowStackTrace([mixed $msg = null ][, mixed &$args = null ]) : mixed

Parameters

$msg : mixed = null
$args : mixed = null

ShowSurveyLogicFile()

Render an HTML "logic file" that lists all expressions, relevances, validations, defaults, subquestions, and answer texts for a survey (or a specific group/question) and reports syntax errors and warnings.


    public
            static        ShowSurveyLogicFile(int $sid[, int|null $gid = null ][, int|null $qid = null ][, int|null $LEMdebugLevel = 0 ][, bool|null $assessments = null ]) : array<string|int, mixed>

The function runs ExpressionManager in a preview "logic" mode, processes the survey (or the specified group/question), evaluates and pretty-prints expressions and replacement strings, and returns an HTML fragment plus a mapping of detected expression errors by question.

Parameters

$sid : int: Survey ID to inspect.
$gid : int|null = null: If provided, restrict output to this group ID; otherwise null to include whole survey or when $qid is provided.
$qid : int|null = null: If provided, restrict output to this question ID; otherwise null.
$LEMdebugLevel : int|null = 0: Bitfield controlling debug output (0 for none).
$assessments : bool|null = null: When true, include assessment-related information; when null, use the survey's assessments setting.

Return values

array<string|int, mixed> —

An associative array with:

'errors' => array mapping "gid~qid" to an integer count of syntax errors for that question (or an integer 1 when a top-level failure occurs),
'html' => string HTML fragment containing the generated logic-file view and any alert banners.

singleton()

Ensures there is only one instances of LEM. Note, if switch between surveys, have to clear this cache


    public
            static    &    singleton() : LimeExpressionManager

Return values

LimeExpressionManager

SplitStringOnExpressions()

Returns an array of string parts, splitting out expressions


    public
            static        SplitStringOnExpressions(string $src) : array<string|int, mixed>

Parameters

$src : string

Return values

array<string|int, mixed>

StartProcessingGroup()

This should be called each time a new group is started, whether on same or different pages. Sets/Clears needed internal parameters.


    public
            static        StartProcessingGroup([int|null $gseq = null ][, bool|null $anonymized = false ][, int|null $surveyid = null ][, bool|null $forceRefresh = false ]) : void

Parameters

$gseq : int|null = null

the group sequence

$anonymized : bool|null = false

whether anonymized

$surveyid : int|null = null

the surveyId

$forceRefresh : bool|null = false

whether to force refresh of setting variable and token mappings (should be done rarely)

StartProcessingPage()

Should be first function called on each page - sets/clears internally needed variables


    public
            static        StartProcessingPage([bool $allOnOnePage = false ][, bool $initializeVars = false ]) : void

Parameters

$allOnOnePage : bool = false

true if StartProcessingGroup will be called multiple times on this page - does some optimizatinos

$initializeVars : bool = false

if true, initializes the replacement variables to enable syntax highlighting on admin pages

StartSurvey()

Initialize a survey so can use EM to manage navigation


    public
            static        StartSurvey(int $surveyid[, string $surveyMode = 'group' ][, array<string|int, mixed> $aSurveyOptions = null ][, bool $forceRefresh = false ][, int $debugLevel = 0 ]) : array<string|int, mixed>

Parameters

$surveyid : int
$surveyMode : string = 'group'
$aSurveyOptions : array<string|int, mixed> = null
$forceRefresh : bool = false
$debugLevel : int = 0

Return values

array<string|int, mixed>

SubQuestionIsRelevant()

Return whether a subquestion is relevant


    public
            static        SubQuestionIsRelevant(string $sgqa) : bool

Parameters

$sgqa : string

Return values

bool

UnitTestConvertConditionsToRelevance()

Return list of relevance equations generated from conditions


    public
            static        UnitTestConvertConditionsToRelevance([int|null $surveyId = null ][, int|null $qid = null ]) : array<string|int, mixed>

Parameters

$surveyId : int|null = null
$qid : int|null = null

Return values

array<string|int, mixed> —

of relevance equations, indexed by $qid

UnitTestProcessStringContainingExpressions()

Unit test strings containing expressions


    public
            static        UnitTestProcessStringContainingExpressions() : mixed

UnitTestRelevance()

Unit test Relevance using a simplified syntax to represent questions.


    public
            static        UnitTestRelevance() : mixed

updateReplacementFields()

Add or replace fixed variable replacement for current page (or until self::resetTempVars was called)


    public
            static        updateReplacementFields(mixed $replacementFields) : mixed

Parameters

$replacementFields : mixed

UpgradeConditionsToRelevance()

Do bulk-update/save of Condition to Relevance


    public
            static        UpgradeConditionsToRelevance([int|null $surveyId = null ][, int|null $qid = null ]) : array<string|int, mixed>

Parameters

$surveyId : int|null = null

if NULL, processes the entire database, otherwise just the specified survey

$qid : int|null = null

if specified, just updates that one question

Return values

array<string|int, mixed> —

of query strings

UpgradeQuestionAttributes()

Deprecate obsolete question attributes.


    public
            static        UpgradeQuestionAttributes([bool|null $changeDB = false ][, int|null $iSurveyID = null ][, int|null $onlythisqid = null ]) : mixed

Parameters

$changeDB : bool|null = false

if true, updates parameters and deletes old ones

$iSurveyID : int|null = null

if set, then only for that survey

$onlythisqid : int|null = null

if set, then only for this question ID

usingCommaAsRadix()

Returns true if the survey is using comma as the radix


    public
            static        usingCommaAsRadix() : bool

Return values

bool

__construct()

A private constructor; prevents direct creation of object


    private
                    __construct() : mixed

_GetVarAttribute()


    private
                    _GetVarAttribute(mixed $name, mixed $attr, mixed $default, int $gseq, int $qseq) : mixed

Parameters

$name : mixed
$attr : mixed
$default : mixed
$gseq : int
$qseq : int

_ProcessGroupRelevance()


    private
                    _ProcessGroupRelevance(int $groupSeq) : void

Parameters

$groupSeq : int

_ProcessRelevance()

Compute Relevance, processing $eqn to get a boolean value. If there are syntax errors, return false.


    private
                    _ProcessRelevance(string $eqn[, string $questionNum = null ][, mixed $gseq = null ][, string $jsResultVar = null ][, string $type = null ][, int $hidden = 0 ]) : bool

Parameters

$eqn : string

the relevance equation

$questionNum : string = null

needed to align question-level relevance and tailoring

$gseq : mixed = null

$jsResultVar : string = null

this variable determines whether irrelevant questions are hidden

$type : string = null

question type

$hidden : int = 0

whether question should always be hidden

Return values

bool

_ProcessSubQRelevance()

Create JavaScript needed to process subquestion-level relevance (e.g. for array_filter and _exclude)


    private
                    _ProcessSubQRelevance(string $eqn[, string $questionNum = null ][, string $rowdivid = null ][, string $type = null ][, string $qtype = null ][, string $sgqa = null ][, string $isExclusive = '' ][, string $irrelevantAndExclusive = '' ]) : bool

Parameters

$eqn : string

the equation to parse

$questionNum : string = null

the question number - needed to align relevance and tailoring blocks

$rowdivid : string = null

the javascript ID that needs to be shown/hidden in order to control array_filter visibility

$type : string = null

the type of subquestion relevance (e.g. 'array_filter', 'array_filter_exclude')

$qtype : string = null

$sgqa : string = null

$isExclusive : string = ''

$irrelevantAndExclusive : string = ''

Return values

bool

_recursivelyFindAntecdentArrayFilters()

Collects all antecedent `array_filter` and `array_filter_exclude` roots that precede a given qroot.


    private
                    _recursivelyFindAntecdentArrayFilters(string $qroot, array<string|int, mixed> $aflist, array<string|int, mixed> $afelist) : array<string|int, mixed>

Recursively traverses dependency links for the provided $qroot, adding unique array_filter codes to $aflist and unique array_filter_exclude codes to $afelist.

Parameters

$qroot : string: The question root variable name to start from.
$aflist : array<string|int, mixed>: Accumulator of discovered array_filter qroot codes; may include existing entries.
$afelist : array<string|int, mixed>: Accumulator of discovered array_filter_exclude qroot codes; may include existing entries.

Return values

array<string|int, mixed> —

[$aflist, $afelist] First element is the accumulated array_filter codes, second is the accumulated array_filter_exclude codes.

_UpdateValuesInDatabase()

Write values to database.


    private
                    _UpdateValuesInDatabase([bool $finished = false ]) : string

Parameters

$finished : bool = false

true if the survey needs to be finalized

Return values

string

_ValidateSurvey()

Check the entire survey


    private
                    _ValidateSurvey([bool $force = false ]) : array<string|int, mixed>

Parameters

$force : bool = false: : force validation to true, even if there are error, used at survey start to fill EM

Return values

array<string|int, mixed> —

with information on validated question

checkValidityAnswer()

Check a validity of an answer, Put the string to show to user $this->invalidAnswerString See mantis #10827, #11611 and #14649


    private
            static        checkValidityAnswer(string $type, string $value, string $sgq, array<string|int, mixed> $qinfo[, bool $set = true ]) : bool

Parameters

$type : string: : question type
$value : string: : the value
$sgq : string: : the sgqa
$qinfo : array<string|int, mixed>: : an array with information from question with mandatory ['qid'=>$qid] , optional (but must be 'other'=>$other)
$set : bool = true: : update the invalid string or not. Used for #14649 (invalid default value)

Return values

bool —

true : if question is OK to be put in session, false if must be set to null

getConditionsForEM()


    private
            static        getConditionsForEM(mixed $surveyid[, mixed $qid = null ]) : mixed

Parameters

$surveyid : mixed
$qid : mixed = null

getQuestionAttributesForEM()

Return array of language-specific answer codes


    private
                    getQuestionAttributesForEM([int|null $surveyid = 0 ][, int|null $qid = 0 ][, string|null $lang = '' ]) : array<string|int, mixed>

Parameters

$surveyid : int|null = 0
$qid : int|null = 0
$lang : string|null = ''

Return values

array<string|int, mixed>

getValidityString()

return the actual validity string , and reset the variable used ($_SESSION)


    private
            static        getValidityString(string $sgqa) : string|null

Parameters

$sgqa : string: : the SGQ (answer name)

Return values

string|null

gT()


    private
                    gT(string $string[, mixed $escapemode = 'html' ]) : mixed

Parameters

$string : string
$escapemode : mixed = 'html'

ngT()


    private
                    ngT(string $sTextToTranslate, int $number[, mixed $escapemode = 'html' ]) : mixed

Parameters

$sTextToTranslate : string
$number : int
$escapemode : mixed = 'html'

resolveOtherJsVarNameOn()

Resolve the on-page JS variable name for a field that may be an "other" text input.


    private
                    resolveOtherJsVarNameOn(string $sgqa, string $type) : string

When $sgqa ends in "other" (i.e. the field name is Q{qid}_Cother), the HTML element ID differs between question types:

QT_L_LIST uses answer{Q{qid}}othertext
QT_EXCLAMATION_LIST_DROPDOWN uses othertext{Q{qid}}

For non-other fields the on-page name is identical to the off-page name java{sgqa}.

Parameters

$sgqa : string: The sub-question field name (e.g. "Q623_Cother" or "Q623")
$type : string: The question type constant (Question::QT_*)

Return values

string —

The resolved on-page JS variable name

throwFatalError()

Kills the survey session and throws an exception with the specified message.


    private
                    throwFatalError([string $message = null ]) : mixed

Parameters

$message : string = null: If empty, a default message is used.

LimeExpressionManager in package Application

Table of Contents

Properties

Methods

Properties

$alias2varName

Tags

$allOnOnePage

$currentGroupSeq

Tags

$currentQID

$currentQset

Tags

$currentQuestionSeq

Tags

$debugLevel

$debugTimingMsg

$em

$gRelInfo

Tags

$groupId2groupSeq

Tags

$groupRelevanceInfo

$groupSeqInfo

Tags

$gseq2info

Tags

$gseq2relevanceStatus

Tags

$indexGseq

Tags

$indexQseq

Tags

$initialized

$instance

$invalidAnswerString

$jsVar2qid

Tags

$knownVars

$lastMoveResult

Tags

$maxGroupSeq

$maxQuestionSeq

$multiflexiAnswers

Tags

$numGroups

$numQuestions

$pageRelevanceInfo

$pageTailorInfo

$ParseResultCache

Tags

$processedRelevance

$q2subqInfo

Tags

$qans

Tags

$qattr

Tags

$qcode2sgq

Tags

$qcode2sgqa

Tags

$qid2code

Tags

$qid2exclusiveAuto

$qid2validationEqn

Tags

$qrootVarName2arrayFilter

$questionId2groupSeq

Tags

$questionId2questionSeq

Tags

$questionSeq2relevance

Tags

$runtimeTimings

Tags

$sessid

$sgqaNaming

$sid

$sPreviewMode

LimeExpressionManager
in package

Application