ExpressionScript - Презентация
From LimeSurvey Manual
Въведение
LimeSurvey използва новия модул ExpressionScript (EM), който позволява на LimeSurvey да поддържа по-сложни разклонения, оценки, валидиране и приспособяване. Той замества начина, по който LimeSurvey управлява Замествания, Условия и Оценки в задната част. Той също така значително ускорява обработката, тъй като елиминира повечето четения на базата данни по време на изпълнение. EM е разработен от д-р Томас Уайт (TMSWhite).
Ключови определения
- 'Израз: Всичко оградено с къдрави скоби:
- Стига да няма бяло пространство непосредствено след отварящата скоба или преди затварящата къдрава скоба.
- Съдържанието на израза се оценява от EM, така че може да съдържа математически формули, функции и сложна обработка на низове и дати.
- Tailoring: Понякога се нарича "piping". Това е процесът на условно модифициране на текст:
- Имате достъп до всички „полета за заместване“, данни за участници и данни за отговори.
- Имате и по-лесен достъп до въпроси, отговори и техните свойства.
- Уместност Уравнение: Нов атрибут на въпрос, контролиращ видимостта на въпроса:
- Ако има уравнение на уместност, тогава въпросът се показва само ако уместността се оценява на истина.
- *Вътрешно всички команди array_filter и array_filter_exclude стават релевантни на ниво подвъпрос.
- SGQA (как променливите са били именувани в миналото) :
- Съкращение от Survey-Group-Question-Answer
- Имената на променливите на SGQA изглеждат като 123X5X382X971 и може да имат суфикси на подвъпроси.
- Тези имена на променливи са специфични за основния S/Q/ G/A кодове на база данни, така че те често трябва да се променят
- Equation Тип въпрос: Нов тип въпрос, който записва изчисления или отчети в базата данни:! N!#*Това е като Boilerplate въпрос, но съдържанието му се записва в базата данни, дори ако зададете „Винаги скрий този въпрос“.
- Код на въпроса: Това е предпочитаното име на променлива за EM:
- Това може да е описателно име, указващо целта на въпроса, което улеснява четенето на сложна логика.
- Валидните кодове на въпроса НЕ трябва да започват с число, така че когато използвате кода на въпроса за номерирайте въпросите си, просто използвайте "q1", или "q1a" или "g1q2".
- Това става името на променливата, ако експортирате данни към SPSS или R. Така че, ако правите статистически анализ, трябва за създаване само на уникални кодове на въпроси.
Трябва ли да използвам EM?
Краткият отговор е „не“. Това обаче до голяма степен зависи от сложността на проучването, което искате да създадете.
Например, Редактор на условия обхваща някои основни изрази, които могат да бъдат приложени към въпросите на вашата анкета. Редакторът на Условията обаче е ограничен. Ето защо се използва EM - той разширява сферата на възможностите за персонализиране.
Мога ли да смесвам условия и уравнения за релевантност?
да Можете да използвате Редактор на условия за някои въпроси и Уравнения за релевантност за други.
Не можете да имате зададени както условия, така и изрази в един и същи въпрос! След като дадено условие е зададено, то замества всеки израз, написан в полето за уравнение за релевантност. Освен това полето Уравнение на релевантността вече не може да се редактира ръчно.
Все пак има начин да използвате както изрази, така и условия в рамките на въпрос. Както бе споменато по-горе, условие замества полето на уравнението за релевантност. След като сте готови, проверете какво е новосъздаденото уравнение и го копирайте в текстов редактор. Изтрийте новосъздаденото условие от Редактор на условия и след това редактирайте въпроса, като добавите базираните на условие изрази от файла на вашия текстов редактор заедно с останалите изрази, които искате да използвате.
Как да избирам между Условия и Уместност?
Ето списък на плюсовете и минусите на всеки стил:
Стил | Плюсове | Минуси |
---|---|---|
Условия | 1. Добър GUI за създаване на прости условия. 2. GUI, добре документиран и разбран от екипа за поддръжка |
1. Поддържа само прости сравнения и не поддържа добре условията „И“ и „ИЛИ“. 2. Каскадните условия работят хаотично 3. Бавно - интензивна база данни - може да забави дългите проучвания. 4. Някои съобщават за проблеми с условията за презареждане. 5. GUI не се мащабира добре, когато има десетки, стотици или хиляди въпроси. 6. Може да е бавно преобразуването на проучвания на хартиен носител, тъй като трябва да използва SGQA имена. 7. Често има нужда от програмист, който да кодира логика по избор, необходима за сложно разклоняване. |
Уместност | 1. Поддържа много сложна логика, включително над 80 функции и математически/низови оператори. 2. Перфектна поддръжка за каскадна логика. 3. Бързо - без допълнителни извиквания към база данни, поддържащи анкети с 1000+ въпроса. 4. Няма проблеми с логиката за презареждане, тъй като не изисква SGQA кодове. 5. Осветяването на синтаксиса се мащабира до 1000+ анкети с въпроси. 6. Лесен и бърз за използване за групи, които искат да компютризират съществуващи анкети на хартиен носител. 7. Лесно поддържа полуструктурирани интервюта и епидемиологични проучвания без нужда от програмист. |
1. Няма GUI за прости условия - вместо това използва маркиране на синтаксис. |
{{Забележка| Забележка:
- Препоръчваме ви да използвате всичко, което отговаря по-добре на вашите нужди.
- За по-подробно обяснение на функциите на EM, щракнете върху следната [[EM and its features|link] ].}}
Първи стъпки
Най-добрият начин да започнете с EM е да:
- Инсталирайте най-новата стабилна версия от https://www.limesurvey.org/en/download.
- Импортирайте и разгледайте някои примерни анкети.
- Разгледайте случаи и инструкции за използване и стъпка- постъпкови примери.
- Разгледайте EM документацията (тази страница)
- Единични тестове на изолирани изрази (разширени)
- показва примери за използване на всички EM функции и оператори и Резултати от PHP и JavaScript;
- обърнете внимание, че има няколко функции, които генерират различни резултати във версиите на PHP и JavaScript, така че тази страница ви позволява да планирате съответно вашата ЕМ логика.
- Единични тестове на изолирани изрази (разширени)
Терминология
Тези думи обикновено се използват за описание на възможностите на EM:
- Relevance-based Branching - ако даден въпрос е подходящ, тогава го задайте, в противен случай не (напр. направете го невидим и маркирайте като NULL в базата данни). Може да намерите Полета за съответствие в панела за редактор на въпроси, както и в панела за редактор на групи въпроси. Последното се използва за прилагане на набор от условия към цяла група, без да се налага да копирате едно и също условие за всеки въпрос и/или да комбинирате условна логика на ниво група и въпрос).
- 'Tailoring' - След като разберете кои въпроси трябва да бъдат зададени, приспособяването (понякога наричано „тръбопроводи“) определя как трябва да бъде зададен въпросът. Това ви позволява да поддържате не само просто заместване (като {TOKEN:FIRSTNAME}), но и спрежение на глаголи и склонение на съществителни въз основа на пола или числото на вашите теми. Също така ви позволява да промените съобщението, което доставяте на респондент в проучването, въз основа на това дали са отговорили (или как са отговорили) на други въпроси.
- Equations'' - EM добавя нов тип въпрос, наречен Уравнение, което съхранява резултата от израз. Резултатите от уравнението се изчисляват и записват в базата данни, дори ако ги скриете на страницата. По този начин те се използват за скрити изчисления на точкуване, навигация въз основа на сложни уравнения, оценки и отчети, които ще бъдат генерирани и съхранени в базата данни.
Уместност и каскадна уместност
Всеки тип въпрос вече има Опция за уместност, която контролира дали въпросът да се показва или не. EM обработва всяко уравнение на релевантността в реда, в който се появяват в проучването. Ако изразът е верен (или липсва - за поддръжка на наследени проучвания), въпросът ще бъде показан. Ако не е уместно, въпросът ще бъде скрит и стойността ще бъде NULL в базата данни. Ако в дадена група няма подходящи въпроси, цялата група ще бъде пропусната.
Освен това, ако някоя от променливите в рамките на израз е неуместна, тогава изразът винаги се оценява като false. Това позволява Каскадна релевантност, така че да не се налага да пишете много дълги уравнения за релевантност за всеки въпрос.
Да кажем, че имате пет въпроса Q1-Q5 и искате да покажете само Q2, ако е отговорено на Q1, и Q3, ако е отговорено на Q2 и т.н. Уравненията за релевантност могат да бъдат:
Код на въпрос | Уместност | Въпрос |
---|---|---|
Q1 | 1 | Как се казвате? |
Q2 | Q1 | {Q1}, на колко години си? |
Q3 | Q2 | И така, ти си на {Q2} години. Женен ли си? |
Q4 | Q3 == "Y" | {Q1}, колко време си женен? |
Q5 | Q4 | Колко деца имаш, {Q1}? |
Уместност на ниво група
ExpressionScript също поддържа уместност на ниво група. Това улеснява прилагането на цикъл. Да кажем, че искате да съберете информация от до 10 обекта (като продукти или хора от домакинство), където първо определяте колко обекта се нуждаят от последващи действия (като например като попитате колко души живеят в домакинство или накарате хората да проверят кои продукти, които харесват от дълъг списък). След като разберете колко обекта се нуждаят от последващи действия, можете да използвате уместност на ниво група като {count >= 1}, {count >=2}, ... {count >= 10} за всяка от 10-те групи последващи въпроси. Във всяка група можете да имате условна логика на ниво въпрос (напр. допълнителни въпроси, свързани с пола или възрастта за всеки предмет). Въпросът и уравненията за релевантност на ниво група се добавят заедно, за да се определи кое трябва да се покаже.
За да проверите такъв пример, импортирайте следното проучване: Census survey example.
Може да се види на екранната снимка по-долу, че групата „Лице 1“ се показва (или е подходяща), ако респондентът живее с поне още един съжител:
Шиване/Пипинг
Всичко във фигурни скоби вече се третира като израз (с едно изключение, описано по-долу). Изразите имат достъп до всички LimeReplacementFields и променливи (чрез няколко псевдонима), всички типични оператори на уравнения (математически, логически и за сравнение) и до десетки функции (които дори работят динамично от страна на клиента).
С помощта на тези уравнения можете да правите неща като:
- Условно показване на персонализирани съобщения на респондентите въз основа на предишни отговори;
- Създаване на оценки и показване на резултатите от оценката (или условно разклоняване или показване на съобщения) въз основа на тези резултати , всичко това без да използвате самия модул за оценяване;
- Спрягайте глаголи и отклонявайте съществителни във въпроси, отговори и доклади;
- Показвайте обобщения на отговорите преди страницата „Показване на вашите отговори“ на край на анкетата.
Уравнения
Има нов тип въпрос, наречен Уравнение. Мислете за него като за Тип въпрос за показване на текст, с изключение на това, че съхранява стойността на това, което се показва в базата данни. Така че, ако текстът на въпроса за уравнението съдържа изчисление за оценка, тази стойност ще бъде съхранена в базата данни в променлива, която може да се показва в публична или частна статистика.
Синтаксис
Всичко, което се съдържа във фигурни скоби, вече се счита за израз (с едно изключение: не трябва да има начално или завършващо празно пространство - това е необходимо, за да се гарантира, че ExpressionScript не се опитва да обработи вграден JavaScript).
Обърнете внимание, че е добре изразите да обхващат няколко реда, стига да няма интервал след отварящата фигурна скоба или преди затварящата фигурна скоба. Това е особено полезно за вложени изрази "if()" като този:
{if(is_empty(PFTotals),
'',
if(PFTotals >= -5 && PFTotals <= -4,
'Много меко',
if(PFTotals >= -3 && PFTotals <= -2,
'Меко',
if(PFTotals == -1,
'Донякъде меко',
if(PFTotals == 0,
'Умерено',! N! if(PFTotals == 1,
'Донякъде трудно',
if(PFTotals >= 2 && PFTotals <= 3,
'Hard',
if(PFTotals >= 4 && PFTotals <= 5,
'Много трудно',
''
)
)
)
)
)
)
)
)}
ExpressionScript поддържа следния синтаксис:
- Всички стандартни математически оператори (напр. +,-,*,/,!);
- Всички стандартни оператори за сравнение (напр. <,<=,==,!=,> ,>=, плюс техните еквиваленти: lt, le, eq, ne, gt, ge);
- Скоби (за да можете да групирате подизрази);
- Условни оператори (напр. &&,| | и техните еквиваленти: и, или);
- Низове с единични и двойни кавички (които могат да вграждат низове с другия тип кавички);
- Оператор запетая (така че може да има списък с изрази и просто да върне крайния резултат );
- Оператор за присвояване (=);
- Предварително дефинирани променливи (за препратка към въпроси, атрибути на въпроси и отговори) - напр. SGQA кодове;
- Предварително дефинирани функции (вече има 80+ и е лесно да добавите още).
Оператори
EM синтаксисът следва нормалния приоритет на оператора:
Ниво | Оператор(и) | Описание |
---|---|---|
1 | () | скоби за групиране или извикване на функции |
2 | ! - + | унарни оператори: не, отрицание, унарно-плюс |
3 | * / | пъти, разделяне |
4 | + - | плюс , минус |
5 | < <= > >= lt le gt ge | относителни сравнения |
6 | == != eq ne | сравнения на равенство |
7 | и | логическо И |
8 | или | логическо ИЛИ |
9 | = | присвояване оператор |
10 | , | оператор със запетая |
Предупреждение за несъответствие на номер и низ и азбучно/цифрово сравнение
Когато искате да сравните стойност с относителни сравнения или сравнения на равенство, обърнете внимание на несъответствията. Стойност, въведена от потребителя (или предоставена чрез код за отговор), може да се използва като число ако очевидно е число.
Ако оградите една от стойностите с "
, сравнението текст/низ ще отнеме място. Ако искате да сравните като число, никога не ограждайте число с "
.
Например Q0.NAOK > "50"
е вярно, ако Q0.NAOK е цифров въпрос със стойност 9. Това е така, защото операторът >
ще приеме, че това е азбучно сравнение, а не числово .
За да сте сигурни, че сравнявате цели числа, можете да използвате intval(Q0.NAOK) > 50
. Само запомнете, ако Q0.NAOK не е число (празен или низ), тогава intval(Q0.NAOK) === 0. За да сравните стойностите на низ ("A" < "B") използвайте strcmp директно: strcmp(Q0.NAOK,"B")
или strcmp(Q0.NAOK,"A5")
.
Внимание при използването на оператор за присвояване (=)
Трябва да избягвате използването на операторите за присвояване, освен ако не е абсолютно необходимо, тъй като те могат да причинят неочаквани странични ефекти. Например, ако промените стойността на предишен отговор, каскадната уместност и логиката на валидиране между този въпрос и текущия въпрос не се изчисляват отново, така че можете да се окажете с вътрешно непоследователни данни (напр. въпроси, на които остава отговор, но трябва са били NULLed или въпроси, които са пропуснати, но е трябвало да получат отговор). По принцип, ако искате да присвоите стойност на променлива, трябва да създадете тип въпрос с уравнение и да използвате израз, за да зададете стойността му. Има обаче редки случаи, в които хората наистина се нуждаят от този оператор, затова го направихме достъпен.
За да ви предупредим за този оператор, той е показан с червен шрифт в синтактичните уравнения (за да не го объркате с "==").
Използване на оператор за присвояване
Основните причини, поради които може да искате да използвате оператора за присвояване, са:
- Трябва да зададете стойността по подразбиране чрез уравнение за въпрос, който не приема стойности по подразбиране (като списъчно радио, където потребителският интерфейс ви позволява да изберете една от опциите за отговор, но не ви позволява да въведете уравнение). Бъдете внимателни обаче, тъй като LimeSurvey няма да може да потвърди, че вашето уравнение генерира един от допустимите отговори за този въпрос;
- Трябва принудително да промените отговора на предишен въпрос въз основа на по-късен отговор;
* и т.н...
Можете да използвате цялата система за управление на изрази за тази цел. По-добре е да използвате Equation за тази цел.
Някои примери:
- Задаване на отговор на кратък текстов въпрос с малки букви:
{QCODE=strtolower(QCODE.NAOK)}
; - Задаване на отговор по подразбиране на тип въпрос от масив в началото на анкета:
{Q1_SQ1=(is_empty(Q1_SQ1.NAOK),"A99",Q1_SQ1.NAOK)}
; - Задаване на отговор по подразбиране за масив с текстов тип въпрос в началото на анкета:
{Q1_SQY1_SQX1 = (is_empty(Q1_SQY1_SQX1.NAOK),"Inserted answer", Q1_SQY1_SQX1.NAOK)}
; - Задайте отговор с условие:
{QCODE=if(YesNo="Y","A1","")}
.
XSS сигурност
При XSS активиран някои части от системата за управление на изрази не могат да се използват:
- започване на HTML таг в израз, но завършване в друг израз;
- използване на сложен израз в URL адрес .
<html>Примери и заобиколни решения:
{if( 1 ,"","")}information{if( 1 ,"","")}
е повредена с XSS защита, тук можете да използвате{if(1," ;
<strong>information</strong>","information")}
;
<a href="/script.php?value={if(QCODE == "Y","yes","no")}">next</a>
, here you can use an equation question because using a complete question code is OK :<a href="/script.php?value={EQUATION.NAOK}">next</a>
. information","information")}{if(1," ;
<a href="/script.php?value={if(QCODE == "Y","yes","no")}">next</a>
, here you can use an equation question because using a complete question code is OK :<a href="/script.php?value={EQUATION.NAOK}">next</a>
.
Достъп до променливи
ExpressionScript предоставя достъп само за четене до променливите, от които се нуждаете. За обратна съвместимост той предоставя достъп до следното:
- TOKEN:xxx - стойността на TOKEN (напр. TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (само за not' ' анонимна анкета).
- INSERTANS:SGQA - показваната стойност на отговор (напр. "Да") - подобно на използването на {QCODE.shown }.
- Всички {XXX} стойности, използвани от шаблони.
- В текста на въпроса можете да използвате {QID}, заменено с идентификатора на въпроса, и {SGQ}, заменено с SGQA на въпроса.
Освен това ExpressionScript ви позволява да се обръщате към променливите чрез кода на въпроса (колоната „заглавие“ в таблицата с въпроси в базата данни). Това също е етикетът на променливата, използван, когато експортирате вашите данни към SPSS, R или SAS. Например, ако имате въпроси относно име, възраст и пол, можете да наречете тези променливи „име“, „възраст“ и „пол“ вместо „12345X13X22“, „12345X13X23“. “ и „12345X13X24”. Това прави уравненията по-лесни за четене и потвърждаване на логиката от всички, плюс това дава възможност за разбъркване на въпроси, без да се налага да следите номерата на групи или въпроси.
Важно: По-безопасно е да се обърнете към променливи, които се срещат в предходните страници или въпроси.
Освен това ExpressionScript ви позволява достъп до много свойства на въпроса:
Синтаксис | Значение | Пример | Примерен резултат | ||||
---|---|---|---|---|---|---|---|
Qcode | псевдоним за Qcode.code | {implode(',',name,gender )} | 'Tom','M' | ||||
Qcode.code | избраният код на отговор за въпроса, ако е подходящ (в противен случай празен), или текстовата стойност, ако не е кодиран въпрос | {implode(',',name.code,gender.code)} | 'Tom','M' | ||||
Qcode.NAOK | същото като Qcode - вижте обсъждането на NAOK | {gender.NAOK} | 'M' | ||||
Qcode.value | оценъчната стойност за въпроса, ако е уместна (в противен случай празна) или текстовата стойност, ако не е кодиран въпрос | {gender.value} | '1' | ||||
Qcode.valueNAOK | същият като Qcode.value - вижте дискусията за NAOK | {gender.valueNAOK} | '1 ' | ||||
Qcode.shown | показваната стойност за въпроса | {implode(',',name.shown,gender.shown)} | - | Qcode.question | текста на въпроса | {gender.question} | 'Какъв е вашият пол?' |
Qcode.mandatory | дали въпросът е задължително (Y/N) | {gender.mandatory} | 'N' | ||||
Qcode.qid | номерът на вътрешния въпрос (не поредният номер) | {gender.qid} | 337 | ||||
Qcode.type | типа на въпроса | {gender.type} | 'G' | ||||
Qcode.jsName | правилното име на javascript за въпроса, независимо дали е деклариран на или извън тази страница | {gender.jsName} | 'java1827X3X337' | ||||
Qcode.gid | номера на вътрешната група (не поредния номер) | {gender.gid} | 3 | ||||
Qcode.qseq | поредният номер на въпроса, започващ от 0 | {gender.qseq} | 5 | ||||
Qcode.gseq | поредния номер на групата, започващ от 0 | {gender.gseq} | 1 | ||||
Qcode.relevanceStatus | дали въпросът е подходящ в момента (0 или 1 ) | {gender.relevanceStatus} | 1 | ||||
Qcode.relevance | уравнението за уместност на ниво въпрос | {gender.relevance} | '!is_empty(name)' | ||||
Qcode.grelevance | уравнението за уместност на ниво група | {gender.grelevance} | 'num_children >= 5' | ||||
Qcode.sgqa | стойността на SGQA за този въпрос | {gender.sgqa} | '1827X3X337' |
Проблем с HTML редактора
Ако използвате HTML редактора, някои знаци се заменят с HTML обекти.
- & от &
- < от <
- > от >
Ако използвате HTML редактор, трябва да използвате :
- и за &
- lt for <
- le for <=
- gt for >
- ge за >=
Препоръчително е да изчистите израза си от HTML, който се появява във вашия израз. Ако използвате HTML редактора на LimeSurvey, щракнете върху бутона „Източник“ (разположен в горната лява част на редактора) и изтрийте всички знаци, които не са свързани с израза ви (напр.
,
, и така нататък).
Именуване на променлива в Qcode
Ето подробностите за това как да конструирате Qcode (и да получите достъп до някои свойства) по тип въпрос. Като цяло Qкодовете се конструират като:
QuestionCode . '_'. ID на подвъпроса. '_'. ScaleId
За comment и other съответните кодове на въпроса са съответно QuestionCode_comment и QuestionCode_other.
Тип | Описание | Код | SubQs | Опции за отговор | Везни | Код на отговора | Отговорът е показан | Уместност |
---|---|---|---|---|---|---|---|---|
5 | 5 Радио бутони за избор на точка | Q1 | 1-5 | {Q1} | {Q1.shown} | {Q1==3} | ||
B | Масив (Избор от 10 точки) Радио-бутони | Q2 | |1-10 | {Q2_L2} | {Q2_L2.shown} | {Q2_L2==7} | ||
A | Масив (избор от 5 точки) Радио-бутони | Q3 | |1-5 | {Q3_1} | {Q3_1.shown} | {Q3_1>=3} | ||
1 | Масив (Гъвкави етикети) Двоен мащаб | Q4 | sq1-sq5 | 0 :a1-a3 | 1:b1-b3 | {Q4_sq1_0} | {Q4_sq1_1.shown} | {Q4_sq1_1=='b2'} |
H | Масив (Гъвкав) - Формат на колона | Q5 | 1-5 | s,m,t | {Q5_1} | {Q5_1.shown} | {Q5_1=='s'} | |
F | Масив (Гъвкав) - Формат на ред | Q6 | |1-5 | {Q6_F3} | {Q6_F3.shown} | {Q6_F3==4} | ||
E | Радио бутони за масив (увеличаване/също/намаляване) | Q7 | 1- 7 | I,S,D | {Q7_4} | {Q7_4.shown} | {Q7_4=='D'} | |
: | Масив (Multi Flexi) 1 до 10 | Q8 | ls1,todo ,ls2 | мин.,макс.,ср. | {Q8_ls1_max} | {Q8_ls2_avg.shown} | {Q8_ls2_min==7} | |
; | Масив (Multi Flexi) Текст | Q9 | hp,st,sw | 1-во, 2-ро, 3-то | {Q9_hp_3rd} | {Q9_hp_3rd.shown} | {Q9_hp_3rd=='Peter'} | |
C | Масив (Да/Несигурно/Не) Радио-бутони | Q10 | 1-5 | Y,N,U | {Q10_1} | {Q10_1.shown} | {Q10_3=='Y'} | |
X | Шаблонен въпрос | Q11 | {Q11.shown} | |||||
D | Дата | Q12 | {Q12} | {Q12.shown} | ||||
* | Уравнение | Q13 | {Q13} | {Q13.shown} | {Q13>5} | |||
~124~ | Качване на файл (записва броя на качените файлове) | Q14 | {Q14} | {Q14>0} | ||||
G | Падащ списък за пол | Q15 | М,Ж | {Q15} | {Q15.shown} | {Q15=='M'} | ||
U | Огромен свободен текст | Q16 | {Q16} | {Q16.shown} | {strlen(Q16)>100} | |||
I | Езиков въпрос | Q17 | {Q17} | {Q17.shown} | {Q17=='en'} | |||
! | Списък – падащо меню | Q18 | 1-5 | {Q18} | {Q18.shown} | {Q18==3} | ||
L | Списък с падащ списък/списък с радио бутони | Q19 | AZ | {Q19} | {Q19.shown} | {Q19=='X'} | ||
O | Списък с падащо меню за коментар/списък с бутони за избор + текстово поле | Q20 | AF | {Q20},{Q20comment} | {Q20.shown} | {Q20=='B'} | ||
T | Дълъг безплатен текст | Q21 | {Q21} | {Q21.shown} | {strstr(Q21,'hello')>0} | |||
M | Квадратче за отметка с множество възможности за избор | Q22 | | | {Q22_E}, {Q22_other} | {Q22_E.shown}, {Q22_other.shown} | {Q22_E=='Y'} | ||
P | Множествен избор с коментари Кутия за отметка + Текст | Q23 | AF | {Q23_D}, {Q23_Dcomment} | {Q23_D.shown} | {!is_empty(Q23)} | ||
K | Въпрос с множество числа | Q24 | self,mom,dad | {Q24_self} | {Q24_self.shown} | {Q24_self>30} | ||
Q | Множество кратки текст | Q25 | AF | {Q25_B} | {Q25_B.shown} | {substr(Q25_B,1,1)=='Q'} | ||
N | Числен тип въпрос | Q26 | {Q26} | {Q26.shown} | {Q26 > 30} | |||
R | Стил на класиране | Q27 | 1-4 | {Q27_1} | {Q27_1.shown} | {Q27_1==3} | ||
S | Кратък безплатен текст | Q28 | {Q28} | {Q28.shown} | {Q28=='moe'} | |||
Y | Да/Не радио-бутони | Q29 | {Q29} | {Q29.shown} | {Q29=='Y'} |
Използване на NAOK
NAOK --> „Неприложимо“ (NA) е наред (OK)
Използването на NAOK означава, че всички или някои от променливите са неуместни (напр. „Неприложимо“ (NA) е наред (OK)).
Например: count(Q1_SQ1,Q1_SQ2,Q1_SQ3,Q1_SQ4) дава винаги празен низ, ако един подвъпрос от Q1 е филтриран. За да преброите броя на проверените подвъпроси в такъв въпрос може да бъде count(Q1_SQ1.NAOK,Q1_SQ2.NAOK ,Q1_SQ3.NAOK,Q1_SQ4.NAOK). Ако подвъпросът е скрит, EM връща празен низ.
Без NAOK, ако един въпрос или един подвъпрос е скрит, EM винаги връща празен низ (същото като връщането на false).
Показаните .naok винаги използват системата NAOK (празен низ, ако е скрит), но ако имате нужда от кода на отговора: винаги е добра идея да добавите .NAOK след кода на въпроса (освен ако имате нужда от него и знаете какво правите).
Повече информация е предоставена в Подраздел за отмяна на каскадни условия.
Запазените променливи "this", "self" и "that"
Доста често искате да оцените всички части на даден въпрос, като например преброяване на колко подвъпроса е отговорено или сумиране на точките. Друг път искате да обработите само определени редове или колони от въпрос (като например получаване на сумите на редове или колони и съхраняването им в базата данни). Тези запазени променливи правят този процес относително безболезнен.
"Тази" променлива
Променливата "this" се използва изключително в опциите "Уравнение за валидиране на целия въпрос" и "Уравнение за валидиране на подвъпрос" (последното не е възможно от GUI). Разширява се до имената на променливите на всяка от клетките в тези въпроси. Така че, ако искате да сте сигурни, че всеки запис е по-голям от три, бихте задали „Уравнение за валидиране на подвъпрос“ на (това > 3).
"Self" променлива
Променливите "self" и "that"' са по-мощни и служат като макроси, които се разширяват преди обработката на уравненията. Изборът на синтаксис за променливата "self" е:
- self
- self.suffix
- self.sub-selector
- self.sub- селектор.суфикс
- суфикс е всеки от нормалните суфикси на qcode (напр. NAOK, стойност, показано)
- подселектор може да бъде едно от следните:
- коментари - само подвъпроси, които са коментари (напр. множествен избор с коментар и списък с коментар);
- nocomments - само подвъпроси, които не са коментари;
- sq_X - където X е идентификатор на ред или колона. Избрани са само подвъпроси, съответстващи на модел X. Обърнете внимание, че търсенето се извършва по пълен кодов идентификатор, след което sq_X съвпада и включва подвъпроси nX, X, Xn (напр. ако използвате sq_1, подвъпросите a1, 1a, 1, 11 или 001 са включени). Обърнете внимание на типа въпрос с двоен мащаб, където кодът на подвъпросите е QCODE_SQCODE_1 и QCODE_SQCODE_1, и на типа въпрос за класиране, където кодът на подвъпроса е QCODE_1,QCODE_2 ....
Примери:
- Отговорено ли е на част от въпрос? -> {count(self.NAOK)>0}
- Каква е оценката за този въпрос? -> {sum(self.value)}
Можете също да ги използвате, за да получите общи суми по редове и колони. Да кажем, че имате масив от числа с редове AE и колони 1-5.
- Каква е общата сума? -> {sum(self.NAOK)}
- Каква е общата сума на ред B? -> {sum(self.sq_B.NAOK)}
- Каква е общата сума в колона 3? -> {sum(self.sq_3.NAOK)}
"Тази" променлива
Променливата "that" е като променливата "self", но ви позволява да препращате към други въпроси. Синтаксисът му е:
- that.qname
- that.qname.suffix
- that.qname.под-селектор' '
- that.qname.под-селектор.суфикс
qname е името на въпроса без никакви разширения на подвъпроса. И така, нека създадем въпрос 'q1', 'q' представляващ също и неговото qname.
Примери:
- Отговорено ли е на част от въпрос q1? -> {count(that.q1.NAOK)>0}
- Каква е оценката за q2? -> {sum(that.q2.NAOK)}
- Каква е общата сума на q3? -> {sum(that.q3.NAOK)}
- Каква е общата сума на ред C в q4? -> {sum(that.q4.sq_C.NAOK)}
- Каква е общата сума от колона 2 в q4? -> {sum(that.q4.sq_2.NAOK)}
The "self" and "that" variables can be used in any relevance, validation, or tailoring.
The one caveat is that when you use the Show logic file feature, it will show you the expanded value of "self" and "that". This lets you see the actual equation that will be generated so that you (and the EM) can validate whether the variables exist or not. This may seem confusing since you may see quite lengthy equations. However, if you edit the question, you will see the original equation using "self" and/or "that".
- you want to explicitly name each variable used in an equation, or
- use variables that do not have subquestions (e.g., single response questions). In those cases, prefixing a variable with "that" is overkill, and you run the risk of getting unexpected results.
Access to functions
The ExpressionScript provides access to mathematical, string, and user-defined functions, as shown below. It has PHP and JavaScript equivalents for these functions so that they work identically on server-side (PHP) and client-side (JavaScript). It is easy to add new functions.
Implemented functions
The following functions are currently available:
Function | Meaning | Syntax |
---|---|---|
abs | Absolute value | number abs(number) |
acos | Arc cosine | number acos(number) |
addslashes | Quote string with slashes | string addslashes(string) |
asin | Arc sine | number asin(number) |
atan | Arc tangent | number atan(number) |
atan2 | Arc tangent of two variables | number atan2(number, number) |
ceil | Round fractions up | number ceil(number) |
checkdate | Returns true(1) if it is a valid date in gregorian calendar | bool checkdate(month,day,year) |
convert_value | Convert a numerical value using a inputTable and outputTable of numerical values | number convert_value(fValue, iStrict, sTranslateFromList, sTranslateToList) |
cos | Cosine | number cos(number) |
count | count the number of answered (non-blank) questions in the list | number count(arg1, arg12, ..., argN) |
countif | Count the number of answered questions in the list equal to the first argument | number countif(matches, arg1, arg2, ... argN) |
countifop | Count the number of answered questions in the list which pass the criteria (arg op value) | number countifop(op, value, arg1, arg2, ... argN) |
date | Format a local date/time | string date(format [, timestamp=time()]) |
exp | Calculates the exponent of e | number exp(number) |
fixnum | Display numbers with comma as radix separator, if needed | string fixnum(number) |
floor | Round fractions down | number floor(number) |
gmdate | Format a GMT date/time | string gmdate(format [, timestamp=time()]) |
html_entity_decode | Convert all HTML entities to their applicable characters (always uses ENT_QUOTES and UTF-8) | string html_entity_decode(string) |
htmlentities | Convert all applicable characters to HTML entities (always uses ENT_QUOTES and UTF-8) | string htmlentities(string) |
expr_mgr_htmlspecialchars | Convert special characters to HTML entities (always uses ENT_QUOTES and UTF-8) | string htmlspecialchars(string) |
expr_mgr_htmlspecialchars_decode | Convert special HTML entities back to characters (always uses ENT_QUOTES and UTF-8) | string htmlspecialchars_decode(string) |
idate | Format a local time/date as integer | string idate(string [, timestamp=time()]) |
if | Excel-style if(test,result_if_true,result_if_false) | if(test,result_if_true,result_if_false) |
implode | Join array elements with a string | string implode(glue,arg1,arg2,...,argN) |
intval | Get the integer value of a variable | int intval(number [, base=10]) |
is_empty | Determine whether a variable is considered to be empty | bool is_empty(var) |
is_float | Finds whether the type of a variable is float | bool is_float(var) |
is_int | Find whether the type of a variable is integer | bool is_int(var) |
is_nan | Finds whether a value is not a number | bool is_nan(var) |
is_null | Finds whether a variable is NULL | bool is_null(var) |
is_numeric | Finds whether a variable is a number or a numeric string | bool is_numeric(var) |
is_string | Find whether the type of a variable is string | bool is_string(var) |
join (New in 2.0 build 130129) | Join elements as a new string | join(arg1, arg2, ... argN) |
list | Return comma-separated list of non-blank values | string list(arg1, arg2, ... argN) |
listifop (New in 3.16.1 ) | Return a 'glue'-separated list of the specified question property (retProp) from questions in the list which pass the criteria (cmpProp op value) | string listifop(cmpProp, op, value, retProp, glue, sgqa1, sgqa2, ... sgqaN) |
ltrim | Strip whitespace (or other characters) from the beginning of a string | string ltrim(string [, charlist]) |
max | Find highest value | number max(arg1, arg2, ... argN) |
min | Find lowest value | number min(arg1, arg2, ... argN) |
mktime | Get UNIX timestamp for a date (each of the 6 arguments are optional) | number mktime([hour [, minute [, second [, month [, day [, year ]]]]]]) |
modulo-function | The modulo function is not supported yet. You can use the floor() function instead | floor(x/y)==(x/y) |
nl2br | Inserts HTML line breaks before all newlines in a string | string nl2br(string) |
number_format | Format a number with grouped thousands | string number_format(number) |
pi | Get value of pi | number pi() |
pow | Exponential expression | number pow(base, exp) |
quoted_printable_decode | Convert a quoted-printable string to an 8 bit string | string quoted_printable_decode(string) |
quoted_printable_encode | Convert a 8 bit string to a quoted-printable string | string quoted_printable_encode(string) |
quotemeta | Quote meta characters | string quotemeta(string) |
rand | Generate a random integer, see this example | int rand() OR int rand(min, max) |
regexMatch | compare a string to a regular expression | bool regexMatch(pattern,input) |
round | Rounds a number to an optional precision | number round(val [, precision]) |
rtrim | Strip whitespace (or other characters) from the end of a string | string rtrim(string [, charlist]) |
sin | Sine | number sin(arg) |
sprintf | Return a formatted string | string sprintf(format, arg1, arg2, ... argN) |
sqrt | Square root | number sqrt(arg) |
stddev | Calculate the Sample Standard Deviation for the list of numbers | number stddev(arg1, arg2, ... argN) |
str_pad | Pad a string to a certain length with another string | string str_pad(input, pad_length [, pad_string]) |
str_repeat | Repeat a string | string str_repeat(input, multiplier) |
str_replace | Replace all occurrences of the search string with the replacement string | string str_replace(search, replace, subject) |
strcasecmp | Binary safe case-insensitive string comparison | int strcasecmp(str1, str2) |
strcmp | Binary safe string comparison | int strcmp(str1, str2) |
strip_tags | Strip HTML and PHP tags from a string | string strip_tags(str, allowable_tags) |
stripos | Find position of first occurrence of a case-insensitive unicode string (starting by 0, return false if not found) | int stripos(haystack, needle [, offset=0]) |
stripslashes | Un-quotes a quoted string | string stripslashes(string) |
stristr | Case-insensitive strstr | string stristr(haystack, needle [, before_needle=false]) |
strlen | Get string length | int strlen(string) |
strpos | Find position of first occurrence of an unicode string (starting by 0, return false if not found) | int strpos(haystack, needle [ offset=0]) |
strrev | Reverse a string | string strrev(string) |
strstr | Find first occurrence of a string | string strstr(haystack, needle[, before_needle=false]) |
strtolower | Make a string lowercase | string strtolower(string) |
strtotime | Parse about any English textual datetime description into a Unix timestamp | int strtotime(string) |
strtoupper | Make a string uppercase | string strtoupper(string) |
substr | Return part of an unicode string | string substr(string, start [, length]) |
sum | Calculate the sum of values in an array | number sum(arg1, arg2, ... argN) |
sumifop | Sum the values of answered questions in the list which pass the criteria (arg op value) | number sumifop(op, value, arg1, arg2, ... argN) |
tan | Tangent | number tan(arg) |
time | Return current UNIX timestamp | number time() |
trim | Strip whitespace (or other characters) from the beginning and end of a string | string trim(string [, charlist]) |
ucwords | Uppercase the first character of each word in a string | string ucwords(string) |
unique | Returns true if all non-empty responses are unique | boolean unique(arg1, ..., argN) |
Create new expression functions with plugin (New in 4.0.0 )
If you need a new function that doesn't exist in core, you can create one with a plugin. Such a new function is created using the expressionManagerStart event.
ExpressionScript knows which variables are local
In order to properly build the JavaScript for a page, EM needs to know which variables are set on the page, and what their JavaScript ID is (e.g., for document.getElementById(x)). It must also know which variables are set on other pages (so that it can ensure that the needed <input type='hidden' value='x'> fields are present and populated).
Cascading Conditions
If any of the variables are irrelevant, the whole equation will be irrelevant (false). For example, in the following table, N/A means that one of the variables was not relevant:
Operator | Example | a | b | Result |
---|---|---|---|---|
+ (unary) | +a | N/A | false | |
! | !a | N/A | false | |
== (or eq) | a == b | N/A | 5 | false |
== (or eq) | a == b | N/A | 0 | false |
== (or eq) | a == b | N/A | N/A | false |
!= (or ne) | a != b | N/A | 5 | false |
!= (or ne) | a != b | N/A | N/A | false |
!= (or ne) | a != b | N/A | 0 | false |
> (or gt) | a > b | N/A | 5 | false |
>= (or ge) | a >= b | N/A | 5 | false |
< (or lt) | a < b | N/A | 5 | false |
<= (or le) | a <= b | N/A | 5 | false |
and | a and b | N/A | 5 | false |
and | a and b | N/A | N/A | false |
or | a or b | N/A | N/A | false |
or | a or b | N/A | 5 | false |
+ | a + b | N/A | 5 | false |
* | a * b | N/A | 5 | false |
/ | a / b | 5 | N/A | false |
() | (a) | N/A | false | |
(exp) | (a && b) | N/A | 5 | false |
(exp) op (exp) | (b + b) > (a && b) | N/A | 5 | false |
function | sum(a,b,b) | N/A | 5 | false |
function | max(a,b) | N/A | 5 | false |
function | min(a,b) | N/A | 5 | false |
function | implode(', ',a,b,a,b) | N/A | 5 | false |
function | if(a,a,b) | N/A | 5 | false |
function | is_empty(a) | N/A | false | |
function | is_empty(a) | 0 (or blank) | true | |
function | !is_empty(a) | N/A | false |
Overriding Cascading Conditions
Say you want to show a running total of all relevant answers. You might try to use the equation {sum(q1,q2,q3,...,qN)}. However, this gets translated internally to LEMif(LEManyNA("q1","q2","q3",...,"qN"),"",sum(LEMval("q1"),LEMval("q2"),LEMval("q3"),...,LEMval("qN"))). So, if any of the values q1-qN are irrelevant, the equation will always return false. In this case, the sum() will show "0" until all questions are answered.
To get around this, each variable can have a ".NAOK" suffix (meaning that Not Applicable is OK) added to it. In such cases, the following behavior occurs. Say you have a variable q1.NAOK:
- q1 is not added to the LEManyNA() clause
- LEMval('q1') will continue to check whether the response is relevant and will return "" if it is not (so individual irrelevant responses will be ignored, but they will not void the entire expression).
So, the solution to the running total problem is to use the equation sum(q1.NAOK,q2.NAOK,q3.NAOK,...,qN.NAOK).
The use of the .NAOK suffix also lets authors design surveys that have several possible paths but then converge on common paths later. For example, say subjects answer a survey in a way that is outside the normal range of responses. The author could alert the subjects that they may not get valid results, and ask them whether they really want to continue with the survey. If they say "Yes", then the rest of the questions will be shown. The condition for the "rest of the questions" would check whether the initial responses were answered within the normal range OR whether the subject said "Yes" to the question that is only relevant if they answered outside the normal range.
How does ExpressionScript support conditional micro-tailoring?
Here is an example of micro-tailoring (where Question Type=='expr' means an Equation):
Question Code | Relevance | Question Type | Question |
---|---|---|---|
name | 1 | text | What is your name? |
age | 1 | text | How old are you? |
badage | !is_empty(age) | expr | {(age<16) or (age>80)} |
agestop | badage | message | Sorry, {name}, you are too {if( (age<16),'young',if( (age>80),'old','middle-aged') ) } for this test. |
kids | !badage | yesno | Do you have children? |
parents | 1 | expr | {!badage && kids=='Y'} |
numKids | parents | text | How many children do you have? |
kid1 | parents && numKids >= 1 | text | How old is your first child? |
kid2 | parents && numKids >= 2 | text | How old is your second child? |
kid3 | parents && numKids >= 3 | text | How old is your third child? |
kid4 | parents && numKids >= 4 | text | How old is your fourth child? |
kid5 | parents && numKids >= 5 | text | How old is your fifth child? |
sumage | 1 | expr | {sum(kid1.NAOK,kid2.NAOK,kid3.NAOK,kid4.NAOK,kid5.NAOK)} |
report | parents | text | {name}, you said you are {age} and that you have {numKids}. The sum of ages of your first {min(numKids,5)} kids is {sumage} |
To download the above survey example, click on the following link: Number of kids survey example.
All of these questions can be on a single page (e.g., in the same group), and only the relevant questions will be displayed. Moreover, as you enter the ages of children, the sum() expression in the last question will dynamically get updated.
ExpressionScript provides this functionality by surrounding each expression with a named <span> element. Every time a value changes, it recomputes the expression that should appear in that <span> element and regenerates the display. You can have dozens or even hundreds of such tailored expressions on the same page.
Syntax highlighting
To help with entering and validating expressions, the EM provides syntax highlighting with the following features:
Types and Meanings of Syntax Highlighting
Color | Sample | Meaning | Tooltip | Comments |
---|---|---|---|---|
tan background | Sample | the whole equation | none | Anything within curly braces that is recognized as an equation (e.g., there is no leading or trailing whitepace) will be color-coded with a tan background to help distinguish it from surrounding text |
bold red text | Sample | An error | Some explanation on error | Can be an unknow variable or an error in function. Survey is broken and the questions that rely on the respective expression will not be shown to the respondents. |
blue text | Sample | function name | meaning and allowable syntax | It refers to function names or things that should be functions since they are followed by an open parenthesis. They are displayed in bold blue text. Tooltips show the meaning and allowable syntax for the function. |
grey text | Sample | string | none | Single and double-quoted strings are shown in grey text. |
cyan text | Sample | variable set on the same page, | [name or SGQA code]: question; value; answerList showing codes for each value | Any variable that is set on the same page as the question you are currently editing is shown in cyan text (it can be updated in javascript). The tooltip shows its name (if you used INSERTANS:xxx) or its SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is shown. |
green text | Sample | variable set on a prior page | [name or SGQA code]: question; value; answerList showing codes for each value | Any variable that is set on a prior page is shown in bold green text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is shown. |
bold pink text | Sample | variable set on a later page in general : empty at survey start, but can be filled with index or move previous | [name or SGQA code]: question; value; answerList showing codes for each value | Any variable that is set on a prior page is shown in bold pink text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is show. |
bold tan text | Sample | a lime replacement value | the value | Lime Replacement Strings (like {TOKEN:xxx}, {PRIVACY_MESSAGE}) are shown in bold tan text. |
red text | Sample | assignment operator (=) | warning message | If you use one of the assignment operator (=), that operator will be displayed in red text. This is meant to help prevent accidental re-assignment of values when you really meant to check whether a == b instead of setting the value of a = b. |
normal black text | Sample | punctuation | none | All other punctuation signs within the expression are shown as normal black text. |
red-boxed text | a bold red line surrounds the error | syntax error | description of the error | Any detected syntax errors are shown within red boxes. The tooltip shows the error. Examples include unmatched parentheses, use of undefined functions, passing the wrong number of arguments to functions, poorly structured expressions (e.g., missing operators between variables), trying to assign a new value to a read-only variable, trying to assign values to non-variables, or using unsupported syntax. Note that the syntax error dectection system may only report one error in an expression even if there are multiple errors; however, if any errors are detected, at least one error will be shown. |