Other languages:

Introducere

LimeSurvey utilizează noul modul ExpressionScript (EM) care îi permite lui LimeSurvey să accepte ramificări, evaluări, validare și personalizare mai complexe. Acesta înlocuiește modul în care LimeSurvey gestionează Înlocuirile, Condițiile și Evaluările în back-end. De asemenea, accelerează considerabil procesarea, deoarece elimină majoritatea citirilor de baze de date în timpul rulării. EM a fost dezvoltat de Dr. Thomas White (TMSWhite).

Definiții cheie

Expresie: Orice înconjurat de acolade:
- Atâta timp cât nu există spațiu alb imediat după acolada de deschidere sau înainte de acolada de închidere.
- Conținutul expresiei este evaluat de EM, deci poate conține formule matematice, funcții și procesare complexă de șiruri și date.
Croitorie: Uneori numită „conductă”. Este procesul de modificare condiționată a textului:
- Aveți acces la toate „câmpurile de înlocuire”, datele participanților și datele de răspuns.
- De asemenea, aveți acces mai ușor la întrebări, răspunsuri și proprietățile acestora. Ecuația
Relevanța: Un nou atribut de întrebare care controlează vizibilitatea întrebării:
- Dacă există o ecuație a relevanței, atunci întrebarea este afișată numai dacă relevanța este evaluată ca adevărată.
*La nivel intern, toate comenzile array_filter și array_filter_exclude devin relevanță la nivel de subîntrebare.
SGQA (cum erau denumite variabilele în trecut) :
- Stands for Survey-Group-Question-Answer
- Numele variabilelor SGQA arată ca 123X5X382X971 și pot avea sufixe de subîntrebări.
- Aceste nume de variabile sunt specifice S/Q/ de bază. Codurile bazei de date G/A, deci acestea trebuie schimbate adesea
Ecuație Tip de întrebare: Un nou tip de întrebare care salvează calcule sau rapoarte în baza de date:
- Este ca o întrebare Boilerplate, dar conținutul ei este salvat în baza de date chiar dacă setați „Ascundeți întotdeauna această întrebare”.
Codul întrebării: Acesta este numele variabilei preferat pentru EM:
- Acesta poate fi un nume descriptiv care indică scopul întrebării, facilitând citirea logicii complexe.
- Codurile de întrebare valide NU ar trebui să înceapă cu un număr, așa că atunci când utilizați codul întrebării pentru a numerotați întrebările dvs., utilizați pur și simplu „q1”, sau „q1a” sau „g1q2”.
- Acesta este ceea ce devine numele variabilei dacă exportați date în SPSS sau R. Deci, dacă faceți analize statistice, aveți nevoie pentru a crea numai coduri unice de întrebare.

Trebuie să folosesc EM?

Răspunsul scurt este „nu”. Totuși, acest lucru depinde în mare măsură de complexitatea sondajului pe care doriți să îl creați.

De exemplu, Editorul de condiții acoperă câteva expresii de bază care pot fi aplicate întrebărilor din sondajul dumneavoastră. Cu toate acestea, editorul de condiții este limitat. De aceea este folosit EM - extinde domeniul posibilități de personalizare.

Pot amesteca condițiile și ecuațiile de relevanță?

Da. Puteți folosi Editorul de condiții pentru unele întrebări și Ecuații de relevanță pentru altele.

Nu puteți avea atât condiții, cât și expresii configurate în aceeași întrebare! Odată ce o condiție este configurată, ea înlocuiește orice expresie este scrisă în câmpul ecuației de relevanță. Mai mult, câmpul Ecuația relevanței nu mai poate fi editat manual.

Totuși, există o modalitate de a folosi atât expresii, cât și condiții în cadrul unei întrebări. După cum sa menționat mai sus, o condiție înlocuiește câmpul ecuației de relevanță. După ce ați terminat, verificați care este ecuația nou creată și copiați-o într-un editor de text. Ștergeți condiția nou creată din Editorul de condiții și apoi editați întrebarea adăugând expresii bazate pe condiții din fișierul dvs. editor de text alături de restul expresiilor pe care doriți să le utilizați.

Cum ar trebui să aleg între Condiții și Relevanță?

Iată o listă cu avantajele și dezavantajele fiecărui stil:

Stil	Pro	Con
Condiții	1. GUI frumos pentru a crea condiții simple. 2. GUI bine documentat și înțeles de echipa de suport	1. Acceptă doar comparații simple și nu condiționează bine „ȘI” și „SAU”. 2. Condițiile în cascadă funcționează neregulat 3. Slow - baza de date intensivă - poate încetini anchetele lungi. 4. Unele probleme raportate cu condițiile de reîncărcare. 5. GUI nu se scalează bine atunci când există zeci, sute sau mii de întrebări. 6. Convertirea anchetelor pe hârtie ar putea fi lentă, deoarece trebuie să utilizeze nume SGQA. 7. Adesea este nevoie de un programator pentru a codifica logica necesară pentru ramificarea complexă.
Relevanță	1. Acceptă o logică foarte complexă, inclusiv peste 80 de funcții și operatori matematici/șir. 2. Suport perfect pentru logica în cascadă. 3. Rapid - fără apeluri suplimentare la baza de date, care acceptă peste 1000 de sondaje cu întrebări. 4. Nicio problemă cu logica de reîncărcare, deoarece nu necesită coduri SGQA. 5. Evidențierea sintaxelor se adaptează la peste 1000 de sondaje cu întrebări. 6. Ușor și rapid de utilizat pentru grupurile care doresc să computerizeze anchetele existente pe hârtie. 7. Suportă cu ușurință interviuri semi-structurate și anchete epidemiologice fără a avea nevoie de un programator.	1. Fără GUI pentru condiții simple - folosește în schimb syntax-highlighting.

{{Notă| Notă:

Vă recomandăm să utilizați orice se potrivește mai bine nevoilor dvs.
Pentru o explicație mai detaliată a caracteristicilor EM, faceți clic pe următorul [[EM și caracteristicile sale|link] ].}}

Noțiuni introductive

Cel mai bun mod de a începe cu EM este să:

Instalați cea mai recentă versiune stabilă de pe https://www.limesurvey.org/en/download.
Importați și explorați câteva Eșantion de anchete.
Explorați cazuri de utilizare și instrucțiuni și pasul- exemple cu pas.
Explorați documentația EM (această pagină)
- Teste unitare ale expresiilor izolate (avansat)
  - arată exemple de utilizare a tuturor funcțiilor și operatorilor EM, precum și Rezultate PHP și JavaScript;
  - rețineți că există puține funcții care generează rezultate diferite în versiunile PHP și JavaScript, așa că această pagină vă permite să vă planificați logica EM în consecință.

Terminologie

Aceste cuvinte sunt utilizate în mod obișnuit pentru a descrie capacitățile EM:

Braching-ul bazat pe relevanță - dacă o întrebare este relevantă, atunci întrebați-o, altfel nu (de exemplu, faceți-o invizibilă și marcați este NULL în baza de date). Puteți găsi Câmpurile de relevanță în panoul editorului de întrebări, precum și în panoul editorului grupului de întrebări. Ultimul este folosit pentru a aplica un set de condiții unui întreg grup fără a fi nevoie să copiați aceeași condiție la fiecare întrebare și/sau să combinați logica condiționată la nivel de grup și la nivel de întrebare).
Adaptare - Odată ce știți ce întrebări ar trebui puse, croitoria (uneori numită „conducte”) specifică modul în care trebuie adresată întrebarea. Acest lucru vă permite să susțineți nu numai înlocuirea simplă (cum ar fi {TOKEN:FIRSTNAME}), ci și conjugarea verbelor și declinarea substantivelor în funcție de genul sau numărul subiecților dvs. De asemenea, vă permite să schimbați mesajul pe care îl transmiteți unui respondent la sondaj în funcție de dacă acesta a răspuns (sau cum a răspuns) la alte întrebări.
Ecuații - EM adaugă un nou tip de întrebare numit Ecuație care stochează rezultatul unei expresii. Rezultatele ecuației sunt calculate și scrise în baza de date, chiar dacă le ascundeți pe pagină. Astfel, acestea sunt folosite pentru calcule ascunse de punctaj, navigare bazată pe ecuații complexe, evaluări și rapoarte care vor fi generate și stocate în baza de date.

Relevanță și relevanță în cascadă

Fiecare tip de întrebare are acum o Opțiune de relevanță care controlează dacă întrebarea este afișată sau nu. EM procesează fiecare ecuație de relevanță în ordinea în care apar în sondaj. Dacă expresia este adevărată (sau lipsește - pentru a sprijini sondajele vechi), întrebarea va fi afișată. Dacă nu este relevantă, atunci întrebarea va fi ascunsă, iar valoarea va fi NULL în baza de date. Dacă nu există întrebări relevante într-un grup, întregul grup va fi omis.

În plus, dacă oricare dintre variabilele dintr-o expresie este irelevantă, atunci expresia este întotdeauna evaluată ca fals. Aceasta permite „Relevanța în cascadă”, astfel încât să nu fie nevoie să scrieți ecuații de relevanță foarte lungi pentru fiecare întrebare.

Să presupunem că aveți cinci întrebări Q1-Q5 și doriți să afișați Q2 doar dacă s-a răspuns Q1 și Q3 dacă s-a răspuns Q2 etc. Ecuațiile de relevanță ar putea fi:

Codul întrebării	Relevanță	Întrebarea
Q1	1	Cum vă cheamă?
Q2	Q1	{Q1}, câți ani ai?
Q3	Q2	Deci, ai {Q2} ani. Ești căsătorit?
Q4	Q3 == "Y"	{Q1}, de cât timp ești căsătorit?
Q5	Q4	Câți copii ai, {Q1}?

Relevanța la nivel de grup

ExpressionScript acceptă, de asemenea, relevanța la nivel de grup. Acest lucru facilitează implementarea buclei. Să presupunem că doriți să colectați informații de la până la 10 entități (cum ar fi produse sau persoane dintr-o gospodărie), unde stabiliți mai întâi câte entități au nevoie de urmărire (cum ar fi întrebând câți oameni locuiesc într-o gospodărie sau cereți-i pe oameni să verifice care produse care le plac dintr-o listă lungă). După ce știți câte entități au nevoie de urmărire, puteți utiliza relevanța la nivel de grup, cum ar fi {count >= 1}, {count >=2}, ... {count >= 10} pentru fiecare dintre cele 10 grupuri de urmărire. sus întrebări. În cadrul fiecărui grup, puteți avea o logică condiționată la nivel de întrebare (de exemplu, întrebări de urmărire specifice sexului sau vârstei pentru fiecare subiect). Întrebarea și ecuațiile de relevanță la nivel de grup sunt combinate AND pentru a determina care ar trebui să fie afișate.

Pentru a verifica un astfel de exemplu, importați următorul sondaj: Exemplu de sondaj de recensământ.

Se poate observa în captura de ecran de mai jos că grupul „Persoana 1” este afișat (sau relevant) dacă respondentul locuiește cu cel puțin un alt conviețuitor:

Croitorie/tubulatură

Orice lucru din acolade este acum tratat ca o expresie (cu o excepție descrisă mai jos). Expresiile au acces la toate câmpurile și variabilele LimeReplacementFields (prin mai multe alias-uri), toți operatorii tipici de ecuație (matematici, logici și de comparație) și la zeci de funcții (care funcționează chiar dinamic pe partea clientului).

Folosind aceste ecuații, puteți face lucruri precum:

Afișați în mod condiționat mesaje personalizate respondenților pe baza răspunsurilor anterioare
Creați evaluări și afișați rezultatele evaluării (sau ramificați sau afișați în mod condiționat mesaje) pe baza acestor rezultate, toate fără a utiliza modulul Evaluări în sine
Conjugați verbe și substantive în declin în întrebări, răspunsuri și rapoarte.
Afișați rezumatele răspunsurilor înainte de pagina „Afișați răspunsurile” de la sfârșitul sondajului

Ecuații

Există un nou tip de întrebare numit Ecuație. Gândiți-vă la el ca un Tip de întrebare de afișare text, cu excepția faptului că stochează valoarea a ceea ce este afișat în baza de date. Deci, dacă textul Întrebarea ecuației conține un calcul de evaluare, acea valoare va fi stocată în baza de date într-o variabilă care poate fi afișată în statisticile publice sau private.

Sintaxă

Orice conținut în acolade este acum considerat o expresie (cu o singură excepție: „„nu trebuie să existe spațiu alb de început sau de final” - acest lucru este necesar pentru a vă asigura că ExpressionScript nu încearcă să proceseze JavaScript încorporat).

Rețineți că este OK ca expresiile să se întinde pe mai multe linii, atâta timp cât nu există spații albe după acolada de deschidere sau înainte de acolada de închidere. Acest lucru este util în special pentru instrucțiunile „if()” imbricate ca acesta:

{dacă(este_gol(PFTotals),
 '',
 dacă(PFTotals >= -5 && PFTotals <= -4,
 „Foarte moale",
 dacă(PFTotals >= -3 && PFTotals <= -2,
 „Moale”,
 dacă(PFTotals == -1,
 „Oarecum moale",
 dacă (PFTotals == 0,
 „Moderată",
if(PFTotals == 1,
 „Oarecum greu”,
 if(PFTotals >= 2 && PFTotals <= 3,
 „Hard",
 if(PFTotals >= 4 && PFTotals <= 5,
 „Foarte greu”,
 ''
 )
 )
 )
 )
 )
 )
 )
)}

ExpressionScript acceptă următoarea sintaxă:

Toți operatorii matematici standard (de exemplu +,-,*,/,!);
Toți operatorii de comparație standard (de exemplu <,<=,==,!=,> ,>=, plus echivalentele lor: lt, le, eq, ne, gt, ge);
Paranteze (deci puteți grupa sub-expresii);
Operatori condiționali (de ex. &&,| | și ai acestora). echivalente: și, sau);
Siruri de caractere simple și duble (care pot încorpora fiecare șiruri cu celălalt tip de ghilimele);
Operator virgulă (deci poate avea o listă de expresii și poate returna doar rezultatul final) );
Operator de atribuire (=);
Variabile predefinite (pentru a se referi la întrebări, atribute ale întrebării și răspunsuri) - de exemplu, codurile SGQA;
Funcții predefinite (există deja peste 80 și este ușor să adăugați mai multe).

Operatori

Sintaxa EM urmează prioritatea normală a operatorului:

Nivel	Operator(i)	Descriere
1	()	paranteze pentru gruparea sau apelarea funcţiilor
2	! - +	operatori unari: nu, negație, unar-plus
3	* /	ori, împărțire
4	+ -	plus , minus
5	< <= > >= lt le gt ge	comparații relative
6	== != eq ne	comparații de egalitate
7	și	ȘI logic
8	sau	SAU
9	=	atribuire operator
10	,	operator virgulă

Template:Notă

Avertisment cu numărul și șirul nepotriviți și comparație alfabetică/numerică

Când doriți să comparați valoarea cu comparații relative sau de egalitate, acordați atenție nepotrivirilor. O valoare introdusă de utilizator (sau furnizată prin codul de răspuns) poate fi folosită ca număr „dacă este clar un număr'. Dacă înconjurați una dintre valori cu " , va fi nevoie de o comparație text/șir. loc. Dacă doriți să comparați ca număr, nu înconjurați niciodată un număr cu " .

De exemplu Q0.NAOK > "50" este adevărat dacă Q0.NAOK este o întrebare numerică cu 9 ca valoare. Acest lucru se datorează faptului că operatorul > va presupune că este o comparație alfabetică și nu una numerică .

Pentru a vă asigura că comparați valori întregi, puteți utiliza intval(Q0.NAOK) > 50 . Nu uitați doar dacă Q0.NAOK nu este un număr (gol sau un șir), atunci intval(Q0.NAOK) === 0. Pentru a compara valorile șirurilor ("A" < "B"), utilizați strcmp direct: strcmp(Q0.NAOK,"B") sau strcmp(Q0.NAOK,"A5") .

Atenție la utilizarea Operatorului de atribuire (=)

Ar trebui să evitați să utilizați operatorii de atribuire decât dacă este absolut necesar, deoarece aceștia pot provoca efecte secundare neașteptate. De exemplu, dacă modificați valoarea unui răspuns anterior, relevanța în cascadă și logica de validare dintre acea întrebare și întrebarea curentă nu este recalculată, astfel încât s-ar putea ajunge la date inconsecvente intern (de exemplu, întrebări la care rămân răspunsuri, dar ar trebui au fost anulate NULL sau întrebări la care au fost omise, dar ar fi trebuit să li se răspundă). În general, dacă doriți să atribuiți o valoare unei variabile, ar trebui să creați un tip de întrebare Ecuație și să utilizați o expresie pentru a-i seta valoarea. Cu toate acestea, există rare ori când oamenii au nevoie cu adevărat de acest operator, așa că l-am pus la dispoziție.

Pentru a vă avertiza cu privire la acest operator, acesta este afișat cu font roșu în ecuațiile de sintaxă (pentru a nu-l confunda cu „==").

Utilizarea operatorului de atribuire

Principalele motive pentru care poate doriți să utilizați operatorul de atribuire sunt:

Trebuie să setați valoarea implicită prin ecuație pentru o întrebare care nu acceptă valori implicite (cum ar fi lista radio, unde interfața cu utilizatorul vă permite să alegeți una dintre opțiunile de răspuns, dar nu vă lasă să introduceți o ecuație). Cu toate acestea, aveți grijă, deoarece LimeSurvey nu va putea valida faptul că ecuația dvs. generează unul dintre răspunsurile permise pentru acea întrebare;
Trebuie să modificați forțat răspunsul la o întrebare anterioară pe baza unui răspuns ulterior;

* etc...

Atenție : Atribuirea se face numai în PHP. Aceasta înseamnă că valoarea nu este actualizată pe aceeași pagină, ci numai atunci când utilizatorul trece la pagina următoare. Prin urmare, vă rugăm să acordați atenție când operatorul de atribuire este folosit pe aceeași pagină cu alte expresii.

Puteți utiliza tot sistemul de gestionare a expresiilor în acest scop. Este mai bine să folosiți o Equation în acest scop.

Câteva exemple:

Setați răspunsul la o întrebare text scurtă cu litere mici: {QCODE=strtolower(QCODE.NAOK)} ;
Setați un răspuns implicit la un tip de întrebare tip matrice la începutul unui sondaj: {Q1_SQ1=(is_empty(Q1_SQ1.NAOK),"A99",Q1_SQ1.NAOK)} ;
Setați un răspuns implicit la un tip de întrebare de tip matrice text la începutul unui sondaj: {Q1_SQY1_SQX1 = (is_empty(Q1_SQY1_SQX1.NAOK),"Inserted answer", Q1_SQY1_SQX1.NAOK)} ;
Setați un răspuns cu condiția: {QCODE=if(YesNo="Y","A1","")} .

securitate XSS

Cu XSS activat, unele părți ale sistemului de gestionare a expresiilor nu pot fi utilizate:

începe o etichetă HTML în expresie, dar se termină cu o altă expresie;
folosind o expresie complexă într-o adresă URL .

Template:Notă

<html>Exemple și soluții:

{if( 1 ,"","")}information{if( 1 ,"","")} sunt deteriorate cu securitatea XSS, aici puteți utiliza {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> .

Acces la variabile

ExpressionScript oferă acces numai în citire la orice variabile de care ai putea avea nevoie. Pentru compatibilitate inversă, oferă acces la următoarele:

TOKEN:xxx - valoarea unui TOKEN (de exemplu, TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (numai pentru „nu) ' sondaj anonim.
INSERTANS:SGQA - valoarea de afișare a unui răspuns (de exemplu, „Da”) - similar cu utilizarea {QCODE.sowned }.
Toate {XXX} valori utilizate de șabloane.
În textul întrebării, puteți folosi {QID} înlocuit cu id-ul întrebării și {SGQ} înlocuit cu SGQA a intrebarii.

În plus, ExpressionScript vă permite să vă referiți la variabile prin codul întrebării (coloana „titlu” din tabelul cu întrebări din baza de date). Aceasta este, de asemenea, eticheta variabilă utilizată atunci când exportați datele în SPSS, R sau SAS. De exemplu, dacă aveți întrebări despre nume, vârstă și sex, puteți numi acele variabile „nume”, „vârstă” și „sex” în loc de „12345X13X22”, „12345X13X23” ' și 12345X13X24. Acest lucru face ca ecuațiile să fie mai ușor de citit și de validat pentru toată lumea, plus făcând posibilă amestecarea întrebărilor fără a fi nevoie să țină evidența numerelor de grup sau de întrebări.

Important: Este mai sigur să vă referiți la variabilele care apar în paginile sau întrebările precedente.

În plus, ExpressionScript vă permite să accesați multe proprietăți ale întrebării:

Sintaxă	Sens	Exemplu	Exemplu de rezultat
Qcode	un alias pentru Qcode.code	{implode(',',nume,gen )}	'Tom','M'
Qcode.code	codul de răspuns selectat pentru întrebare dacă este relevant (în caz contrar gol), sau valoarea textului dacă nu este un întrebare codificată	{implode(',',name.code,gender.code)}	'Tom','M'
Qcode.NAOK	la fel ca Qcode - vezi discuția despre NAOK	{gender.NAOK}	'M'
Qcode.value	valoarea de evaluare a întrebării dacă este relevantă (în caz contrar gol), sau valoarea textului dacă nu este o întrebare codificată	{gender.value}	'1'
Qcode.valueNAOK	la fel ca Qcode.value - vezi discuția despre NAOK	{gender.valueNAOK}	'1 '
Qcode.sown	valoarea de afișare pentru întrebare	{implode(',',name.sown, gender.sown)}	'Tom','Male'
Qcode.question	textul întrebării	{gender.question}	'Care este genul tău?'
Qcode.obligatoriu	dacă întrebarea este este obligatoriu (Y/N)	{gender.mandatory}	'N'
Qcode.qid	numărul intern al întrebării (nu numărul secvenţial)	{gender.qid}	337
Qcode.type	tipul întrebării	{gender.type}	'G'
Qcode.jsName	numele javascript corect pentru întrebare, indiferent dacă este declarată pe sau în afara acestei pagini	{gender.jsName}	'java1827X3X337'
Qcode.gid	numărul grupului intern (nu numărul secvenţial)	{gender.gid}	3
Qcode.qseq	numărul secvenţial al întrebării, începând de la 0	{gender.qseq}	5
Qcode.gseq	numărul secvenţial al grupului, începând de la 0	{gender.gseq}	1
Qcode.relevanceStatus	dacă întrebarea este relevantă în prezent (0 sau 1)	{gender.relevanceStatus}	1
Qcode.relevance	ecuația relevanței la nivel de întrebare	{gender.relevance}	'!is_empty(name)'
Qcode.grelevance	ecuația relevanței la nivel de grup	{gender.grelevance}	'num_children >= 5'
Qcode.sgqa	valoarea SGQA pentru această întrebare	{gender.sgqa}	'1827X3X337'

Problemă cu editorul HTML

Dacă utilizați editorul HTML, unele caractere sunt înlocuite cu entități HTML.

& prin &
< prin <
> prin >

Dacă utilizați editorul HTML, trebuie să utilizați :

și pentru &
lt pentru <
le for <=
gt for >
ge pentru >=

Se recomandă să ștergeți expresia HTML care apare în expresia dvs. Dacă utilizați editorul HTML LimeSurvey, faceți clic pe butonul „Sursă” (situat în partea din stânga sus a editorului) și ștergeți toate caracterele care nu au legătură cu expresia dvs. (de exemplu,

,
, și așa mai departe).

Denumirea variabilelor Qcode

Iată detaliile despre cum să construiți un Qcode (și să accesați unele proprietăți) după tipul de întrebare. În general, Qcodes sunt construite ca:

 QuestionCode . '_' . SubQuestionID . '_' . ScaleId

Pentru comment și other, codurile de întrebare corespunzătoare sunt QuestionCode_comment și, respectiv, QuestionCode_other.

Tip	Descriere	Cod	SubQs	Opțiuni de răspuns	Scale	Cod de răspuns	Răspuns afișat	Relevanță
5	5 Butoane radio pentru alegerea punctului	Q1		1-5		{Q1}	{Q1.afisat}	{Q1==3}
B	Matrice (alegere 10 puncte) Butoane radio	Q2	\|1-10		{Q2_L2}	{Q2_L2.afisat}	{Q2_L2==7}
A	Matrice (Alegere 5 puncte) Butoane radio	Q3	\|1-5		{Q3_1}	{Q3_1.prezentat}	{Q3_1>=3}
1	Matrice (etichete flexibile) scară duală	Q4	sq1-sq5	0 :a1-a3	1:b1-b3	{Q4_sq1_0}	{Q4_sq1_1.show}	{Q4_sq1_1=='b2'}
H	Matrice (Flexibilă) - Format de coloană	Q5	1-5	s,m,t		{Q5_1}	{Q5_1.prezentat}	{Q5_1=='s'}
F	Matrice (Flexibilă) - Format rând	Q6	\|1-5		{Q6_F3}	{Q6_F3.afisat}	{Q6_F3==4}
E	Matrice (Mărire/Același/Scădere) Butoane radio	Q7	1- 7	I,S,D		{Q7_4}	{Q7_4.show}	{Q7_4=='D'}
:	Matrice (Multi Flexi) 1 până la 10	Q8	ls1,todo ,ls2	min,max,avg		{Q8_ls1_max}	{Q8_ls2_avg.sown}	{Q8_ls2_min==7}
;	Text matrice (Multi Flexi)	Q9	hp,st,sw	1, 2, 3		{Q9_hp_3rd}	{Q9_hp_3rd.shown}	{Q9_hp_3rd=='Peter'}
C	Matrice (Da/Nesigur/Nu) Butoane radio	Q10	1-5	Y,N,U		{Q10_1}	{Q10_1.prezentat}	{Q10_3=='Y'}
X	Întrebare generală	Q11					{Q11.afisat}
D	Data	Q12				{Q12}	{Q12.arată}
*	Ecuație	Q13				{Q13}	{Q13.show}	{Q13>5}
~124~	Încărcare fișier (înregistrează numărul de fișiere încărcate)	Q14				{Q14}		{Q14>0}
G	Lista derulantă de gen	Q15		M,F		{Q15}	{Q15.arată}	{Q15=='M'}
U	Text imens gratuit	Q16				{Q16}	{Q16.arată}	{strlen(Q16)>100}
I	Întrebare de limbă	Î17				{Q17}	{Q17.show}	{Q17=='ro'}
!	Lista - dropdown	Q18		1-5		{Q18}	{Q18.afisat}	{Q18==3}
L	Listă derulantă/listă de butoane radio	Q19		AZ		{Q19}	{Q19.show}	{Q19=='X'}
O	Lista cu meniul drop-down/listă cu butoane radio + text	Q20		AF		{Q20},{Q20comment}	{Q20.show}	{Q20=='B'}
T	Long Free Text	Q21				{Q21}	{Q21.shown}	{strstr(Q21,'hello')>0}
M	Casa de selectare cu alegeri multiple	Q22	\|		{Q22_E}, {Q22_other}	{Q22_E.show}, {Q22_other.shown}	{Q22_E=='Y'}
P	Casa de selectare cu opțiuni multiple cu comentarii + Text	Q23	AF			{Q23_D}, {Q23_Dcomment}	{Q23_D.show}	{!is_empty(Q23)}
K	Întrebare numerică multiplă	Q24	self,mam,tata			{Q24_self}	{Q24_self.shown}	{Q24_self>30}
Q	Multiple Short Text	Q25	AF			{Q25_B}	{Q25_B.arată}	{substr(Q25_B,1,1)=='Q'}
N	Tipul de întrebare numerică	Q26				{Q26}	{Q26.afisat}	{Q26 > 30}
R	Stil de clasare	Q27	1-4			{Q27_1}	{Q27_1.prezentat}	{Q27_1==3}
S	Scurt text gratuit	Q28				{Q28}	{Q28.afisat}	{Q28=='al meu'}
Y	Da/Nu Radio-Butoane	Q29				{Q29}	{Q29.afisat}	{Q29=='Y'}

Utilizarea NAOK

NAOK --> „Nu se aplică” (NA) este în regulă (OK)

Utilizarea NAOK înseamnă că toate sau unele dintre variabile sunt irelevante (de exemplu, „Nu se aplică” (NA) este în regulă (OK)).

For example: count(Q1_SQ1,Q1_SQ2,Q1_SQ3,Q1_SQ4) give always an empty string if one subquestion of Q1 is filtered. To count the number of checked subquestion in such question can be count(Q1_SQ1.NAOK,Q1_SQ2.NAOK,Q1_SQ3.NAOK,Q1_SQ4.NAOK). If the subquestion is hidden, the EM returns an empty string.

Without NAOK, if one question or one subquestion is hidden, the EM returns always an empty string (same to returning false).

The .shown always use the NAOK system (empty string if hidden) but if you need the code of the answer: it's always a good idea to add .NAOK after the question code (except if you need it and know what you do).

More information is provided in the Overriding Cascading Conditions subsection.

The reserved "this", "self", and "that" variables

Quite often you want to evaluate all the parts of a question, such as counting how many subquestions have been answered or summing up the scores. Other times you want to process just certain rows or columns of a question (such as getting the row or column sums and storing them in the database). These reserved variables make that process relatively painless.

"This" variable

The "this" variable is used exclusively within the "Whole question validation equation" and "Subquestion validation equation" options (the later is not possible from GUI). It expands to the variable names of each of the cells within those questions. So, if you want to make sure that each entry is greater than three, you would set the "Subquestion validation equation" to (this > 3).

"Self" variable

The "self" and "that" variable are more powerful, and serve as macros which are expanded prior to processing equations. The syntax choices for the "self" variable are:

self
self.suffix
self.sub-selector
self.sub-selector.suffix

suffix is any of the normal qcode suffixes (e.g., NAOK, value, shown)

sub-selector can be one of the following:

comments - only subquestions that are comments (e.g., multiple choice with comment and list with comment);
nocomments - only subquestions that are not comments;
sq_X - where X is a row or column identifier. Only subquestions matching pattern X are selected. Note that search is done on complete code identifier, then sq_X match and include subquestions nX, X, Xn (e.g. if you use sq_1, subquestions a1, 1a, 1, 11 or 001 was included). Put attention at dual scale question type where subquestions code are QCODE_SQCODE_1 and QCODE_SQCODE_1 and to ranking question type where subquestions code are QCODE_1,QCODE_2 ....

Examples:

Has any part of a question been answered? -> {count(self.NAOK)>0}
What is the assessment score for this question? -> {sum(self.value)}

You can also use these to get row and column totals. Say you have an array of numbers with rows A-E and columns 1-5.

What is the grand total? -> {sum(self.NAOK)}
What is the total of row B? -> {sum(self.sq_B.NAOK)}
What is the total of column 3? -> {sum(self.sq_3.NAOK)}

"That" variable

The "that" variable is like the "self" variable, but it allows you to refer to other questions. Its syntax is:

that.qname
that.qname.suffix
that.qname.sub-selector
that.qname.sub-selector.suffix

qname is the question name without any subquestion extensions. So, let's create a question 'q1', 'q' representing also its qname.

Examples:

Has any part of question q1 been answered? -> {count(that.q1.NAOK)>0}
What is the assessment score for q2? -> {sum(that.q2.NAOK)}
What is the grand total of q3? -> {sum(that.q3.NAOK)}
What is the total of row C in q4? -> {sum(that.q4.sq_C.NAOK)}
What is the total of column 2 in 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 should not use these variables if

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)

Click here if you wish to find out more about planned (or being constrained) functions.

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.

By tooltips, we refer to the popup message that is displayed when you hover over certain functions and variables.

ExpressionScript - Prezentare

From LimeSurvey Manual

Revision as of 11:00, 10 November 2023 by Maren.fritz (talk | contribs) (Created page with "NAOK --> „Nu se aplică” (NA) este în regulă (OK)")(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)