Revision as of 21:24, 25 May 2020

Other languages:

Inleiding

In LimeSurvey wordt de nieuwe module ExpressionScript (EM) gebruikt, waarmee LimeSurvey meer complexe vertakkingen, beoordelingen, validatie en maatwerk kan ondersteunen. Het vervangt hoe LimeSurvey de vervangingen, condities en beoordelingen op het beheerdeel beheert. Doordat er nu ook minder wordt gelezen in de database, betekent het ook een snellere werking. EM is ontworpen door Dr. Thomas White (TMSWhite).

Definities

Expressie: Alles tussen accolades:
- As er tenminste geen spatie na de opening-accolade of voor de sluit-accolade staat.
- De inhoud van de expressie wordt verwerkt door EM, het kan mathematische functies, functies en complexe tekst en datum verwerking bevatten.
Maatwerk: Ook wel "tailoring" of "piping". Het metcondities wijzigen van tekst:
- Er is toegang tot alle te vervangen velden, deelnemersgegevens en in de enquête ingevoerde gegevens.
- Ook toegang tot vragen, antwoorden en hun eigenschappen.
Relevantievergelijking: Een vraagattribuut dat zorgt voor het wel of niet tonen van de vraag:
- als er een relevantievergelijking is dan wordt de vraag getoond als de uitkomst ervan 'true' is.
- Intern, alle array_filter en array_filter_exclude commando's worden relevantie op subvraag-niveau.
SGQA (oude naamgeving variabelen):
- Staat voor Survey-Group-Question-Answer
- SGQA variabele is bijvoorbeeld 123X5X382X971, er kan een achtervoegsel van de subvraag zijn.
- Omdat deze namen samengesteld uit de onderliggende codes van de enquête, groep,vraag en subvraag kunnen ze soms gewijzigd moeten worden
Vergelijking Een vraagtype waarmee een resultaat van een berekening of een rapport opgeslagen kunnen worden in de database:
- Het is een Boilerplate vraag, het wordt opgeslagen ook als de vraag het attribuut 'altijd verbergen' heeft.
Vraagcode: De voorkeursnaamgeving:
- Dit is een beschrijvende naam wat dus het doel van de vraag aangeeft en wat de leesbaarheid gemakkelijker maakt bij complexe constructies..
- Een vraagcode mag niet beginnen met een nummer, dus als je je vragen wilt nummeren gebruik dan "v1", of "v1a" of "v1q2" in plaats van alleen een volgnummer.
- Dit wordt als naam van de variabele gebruikt bij exporteren naar SPSS of R. Zorg ervoor dat je alleen unieke codes gebruikt anders heb je weinig aan die vragen als je er later een analyse van wilt maken.

Moet ik EM gebruiken?

Nee, je hoeft EM niet te gebruiken, maar als je enquête wat meer complex wordt, dan is het wel handiger.

De Conditie-editor ondersteunt bijvoorbeeld ook wat eenvoudige expressies die je bij je vragen kunt gebruiken. In EM wordt veel meer ondersteund.

Kan ik zowel condities als relevantievergelijkingen gebruiken?

Ja. Je kunt bij de ene vraag de Conditie-editor gebruiken en bij een andere een Relevantievergelijking.

Maar je kunt ze niet beide in dezelfde vraag gebruiken! Als je een conditie maakt dan gaat de expressie in de relevantievergelijking verloren. Bovendien kan het veld van de relevantievergelijking niet meer handmatig worden aangepast.

Met wat rommelen kan het je wel lukken, maar waarom zou je dat willen. Je moet dan de relevantievergelijking in een editor bewaren. Verwijder dan de nieuwe conditie in de Conditie-editor en wijzig de vraag door de expressie van de conditie gecombineerd met de bewaarde relevantievergelijking in te vullen.

Kiezen tussen conditie en relevantie

Een lijst van voordelen en nadelen van beide:

Style	Voor	Tegen
Condities	1. Mooie GUI voor aanmaken van eenvoudige condities. 2. GUI goede documentatie en ondersteuning	1. Alleen simpele vergelijkingen en matige "AND" of "OR" condities. 2. Nesten condities kan problemen geven 3. Langzaam, veel gebruik database bij grote enquêtes. 4. Er zijn soms problemen met herladen van condities. 5. GUI matig schalen bij dozijn, honderd of duizend vragen. 6. Langzamere conversie bij papieren enquêtes omdat er SGQA namen gebruikt moeten worden. 7. Bij complexe vertakkingen kan alleen een ervaren persoon het aanpassen.
Relevantie	1. Ondersteunt erg complexe logica met meer dan 80 ingebouwde functies en mathematische / tekst operatoren. 2. Perfecte ondersteuning in trapsgewijze logica. 3. Snel, geen extra aanroepen database, ondersteunt enquête met 1000+ vragen. 4. Herladen werkt prima omdat er geen SGQA-codes nodig zijn. 5. Syntax-highlighting schaalt tot een enquête mer meer dan 1000 vragen. 6. Gemakkelijk en eenvoudig voor groepen de papieren enquêtes willen verwerken. 7. Ondersteunt semi-gestructureerde interviews en epidemiologische enquête zonder dat je een programmeur nodig hebt.	1. Geen GUI voor eenvoudige condities - het maakt gebruikt van syntax-highlighting.

NB:

Kies wat het beste aansluit met wat je nodig hebt.
Meer informatie over EM.

Beginnen

Je kunt het beste beginnen met EM door:

De meeste recente versie te downloaden van https://www.limesurvey.org/en/download.
Importeer en bekijk enkele voorbeelden van enquêtes.
Neem door de use cases en uitleg over het gebruik en de voorbeelden.
Bestudeer deze pagina
- Unit-testen van geïsoleerde expressies (geadvanceerd)
  - toont voorbeelden met alle EM functies en operatoren, en de resultaten in PHP en JavaScript
  - bij enkele functies kan soms een ander resultaat worden gegeven afhankelijk van de versie PHP en JavaScript, hou hier dus rekening mee en bekijk het.

Terminologie

De mogelijkheden van ExpressionScript wordt vaak beschreven met de begrippen:

Relevantie gebaseerde vertakking : als een vraag relevant is stel die vraag dan en anders niet (maak de vraag bijvoorbeeld onzichtbaar en sla het op als NULL in de database). De relevantie-velden staan in het paneel van het wijzigen vragen of van een vraaggroep. Dat laatste is bedoeld om een (of meer) conditie te kunnen zetten op een hele groep zonder steeds die conditie op elke vraag te zetten en/of conditionele logica te combineren voor een groep en vraag.
Maatwerk : Als een vraag wordt gesteld dan kun je met maatwerk (tailoring, piping) de vraag wat opmaken. naast simpele vervangingen als {TOKEN:FIRSTNAME} gebruiken zodat daar de voornaam van de deelnemer komt kun je ook de tekst aanpassen voor werkwoorden op grond van bijvoorbeeld een aantal of het geslacht. Je kunt ook de vraag aanpassen aan een eerder gegeven antwoord van de deelnemer.
Vergelijkingen : Met het vraagtype Vergelijking kun je het resultaat van een expressie opslaan in de database, ook als je deze vraag verbergt. Je kunt op het resultaat van berekeningen en beoordelingen navigeren en ook rapporten opslaan.

Relevantie en trapsgewijze relevantie

Elk vraagtype heeft een optie relevantie die bepaald of de vraag moet worden gesteld. Ze worden verwerkt in de volgorde dat ze in de enquête staan. Als de expressie waar is (of ontbreekt, dit om oudere enquêtes te blijven ondersteunen) dan wordt de vraag gesteld. Als de vraag niet gesteld wordt dan wordt de waarde NULL opgeslagen. Als er geen enkele relevante vraag in de groep is, dan wordt de hele groep overgeslagen.

Als een van de variabelen in de expressie niet relevant is, dan is die vraag niet relevant. Dit is dus een trapsgewijze relevantie waardoor je niet hele lange relevantievergelijkingen voor elke vraag hoeft te schrijven.

Stel je hebt 5 vragen Q1-Q5, en je wilt alleen vraag Q2 stellen als vraag Q1 beantwoord is. Ook wil je vraag Q3 alleen stellen als vraag Q2 beantwoord is. De relevantievergelijkingen kunnen dan zijn:

Vraag Code	Relevantie	Vraag
Q1	1	Wat is uw naam?
Q2	Q1	{Q1}, hoe oud bent u?
Q3	Q2	Dus u bent {Q2} jaar oud. Bent u getrouwd?
Q4	Q3 == "Y"	{Q1}, hoelang bent u getrouwd?
Q5	Q4	Hoeveel kinderen heeft u, {Q1}?

Relevantie op groepsniveau

ExpressionScript ondersteunt ook relevantie op groepsniveau. Je kunt hiermee ook een groep vragen een aantal keren herhalen. Stel je wilt van elk persoon in een huishouden iets weten ,dan kun je dus eerst vragen hoeveel personen er zijn in het huishouden en dan per persoon je vragen stellen over die persoon. Dit is dan groepsrelevantie {count >= 1}, {count >=2}, ... {count >= 10} voor elk tot de maximaal 10 eerder opgegeven aantal personen. Binnen de groep vragen heb je dan relevantie en maatwerk per vraag. De verschillende relevanties worden gecombineerd met AND om te bepalen of een vraag of groep getoond moet worden.

We hebben een voorbeeld, dat je kunt importeren.

In de onderstaande afbeelding kun je zien dat de groep Person 1 relevant is als de deelnemer samenleeft met minstens een ander persoon:

Maatwerk

Alles tussen accolades wordt beschouwd als een expressie (met een uitzondering die hieronder wordt beschreven). Expressies kunnen beschikken over alle vervangingsvelden, alle variabelen (via verschillende aliassen), alle vergelijkingsoperatoren (rekenkundig, logisch en vergelijkend) en veel functies (die ook dynamisch op de server uitgevoerd kunnen worden).

Met deze vergelijkingen kun je dingen doen als:

Conditioneel tonen van op maat gesneden berichten aan de respondenten die gebaseerd zijn op antwoorden op voorafgaande vragen.
Beoordelingen maken en de resultaten daarvan conditioneel tonen (of conditioneel een vertakking maken), alles zonder de module beoordeling te gebruiken.
De goede werkwoordsvormen en zelfstandige naamwoorden gebruiken in vragen, antwoorden en rapporten.
Tonen van samenvattingen van antwoorden bij het einde van de enquête.

Vergelijkingen

Er is een vraagtype Vergelijking toegevoegd. Het lijkt op het Tekst scherm vraagtype, maar bij het nieuwe vraagtype wordt de waarde of wat er wordt getoond, opgeslagen in de database. Dus, als de tekst van een vergelijking vraag een berekening van een beoordeling bevat, dan wordt die waarde opgeslagen in een variabele die getoond kan worden bij statistieken.

Syntax

De uitzondering op dat alles tussen accolades een expressie is, is dat er geen spatie(s) na de begin-accolade en voor de sluit-accolade mogen staan. Dit is nodig om te voorkomen dat ExpressionScript probeert JavaScript te gaan verwerken.

NB: Expressies mogen meerdere regels bevatten, zolang er maar geen spaties staan na een openingshaakje of voor een sluithaakje. Een voorbeeld met een genest if( ) statement:

{if(is_empty(PFTotals),
 '',
 if(PFTotals >= -5 && PFTotals <= -4,
   'Heel weinig',
   if(PFTotals >= -3 && PFTotals <= -2,
     'Weinig',
     if(PFTotals == -1,
       'Minder dan normaal',
       if(PFTotals == 0,
         'Normaal',
         if(PFTotals == 1,
           'Meer dan normaal',
           if(PFTotals >= 2 && PFTotals <= 3,
             'Veel',
             if(PFTotals >= 4 && PFTotals <= 5,
               'Heel veel',
               ''
             )
           )
         )
       )
     )
   )
 )
)}

ExpressionScript heeft als syntax:

Alle standaard mathematische operatoren (bijv. +,-,*,/,!)
Alle standaard vergelijkingen (<,<=,==,!=,>,>=, en ook hun tegenhangers: lt, le, eq, ne, gt, ge)
Haakjes (voor een subexpressie)
Conditionele operatoren (bijv. &&,| | en de tegenhangers: and, or);
Enkele en dubbele quotes in teksten
Komma operator (als scheidingsteken tussen meerdere expressies en dan alleen het eindresultaat teruggeven)
Toekenning operator (=)
Voorgedefinieerde variabelen (referentie naar een vraag, een vraagattribuut of een antwoord): bijv, de SGQA identifier
Voorgedefinieerde functies

Operatoren

De volgorde van verwerken van operatoren is normaal.

Niveau	Operator(en)	Beschrijving
1	()	haakjes voor groepen en functies
2	! - +	een varibele: not, negation, unary-plus
3	* /	vermenigvuldigen, delen
4	+ -	optellen,aftrekken
5	< <= > >= lt le gt ge	relatieve vergelijkingen
6	== != eq ne	gelijkheid vergelijkingen
7	and	logische AND
8	or	logische OR
9	=	toekennen operator
10	,	komma operator

Om JavaScript en PHP gelijk te laten werken, werkt de plus operator (+) als optellen als beide velden numeriek zijn en als samenvoegen als beide velden niet numeriek (strings) zijn. Je kunt beter de join( ) functie gebruiken voor het samenvoegen want dan is de bedoeling duidelijker en voorkomt onverwachte resultaten als de invoer afwijkt van wat je verwacht.

Waarschuwing met niet-overeenkomend nummer en string en alfabetische / numerieke vergelijking

Wanneer je waarden wilt vergelijken met relatieve of gelijkheid, let dan op mismatch. De door de gebruiker ingevoerde waarde of de geselecteerde antwoordcode kan als getal worden gebruikt als het duidelijk een getal is. Als je een van de waarden omringt met " : forceer je een vergelijking als tekst. Als je wilt vergelijken als getal, zet het getal dan niet tussen " .

Voorbeeld: Q0.NAOK > "50" is TRUE als Q0.NAOK een numerieke vraag is met 9 als waarde. Dit komt omdat de operator > ervan uitgaat dat het een alfabetische vergelijking is en dus geen numerieke vergelijking.

Om er zeker van te zijn dat de invoer als getallen worden vergeleken kun je het volgende doen intval(Q0.NAOK) > 50, bedenk dat als Q0.NAOK geen getal is (leeg of een string), dat dan intval(Q0.NAOK) === 0. Gebruik om als strings te vergelijken ("A" < "B") strcmp : strcmp(Q0.NAOK,"B") of strcmp(Q0.NAOK,"A5").

Uitkijken met gebruik operator (=)

Probeer het gebruik van de toekenningsoperator te vermijden, het kan onverwachte bijeffecten hebben. Als je bijvoorbeeld het antwoord van een vorige vraag aanpast wordt de trapsgewijze relevantie en validatie tussen die vraag en de huidige vraag niet opnieuw bepaald. Dit kan dus tot inconsistente gegevens leiden (vragen die ingevuld blijven in plaats van gewist worden, of vragen die verplicht geworden zijn maar niet gesteld zijn). Als je een variabele een waarde wil geven gebruik dan een vraag met het vraagtype vergelijking. Als je de toekenning echt nodig hebt dan is het wel mogelijk.

Om het gebruik van de operator toekennen wat duidelijker aan te geven, tonen we het in rode tekst in de syntaxvergelijking. (Verwar deze operator niet met de gelijkheidsvergelijking "==".)

Gebruik toekenningsoperator

De belangrijkste redenen om deze operator te gebruiken:

Je wilt een standaardwaarde zetten voor een vraag, waar dat niet met een expressie kan (een radiolijst, waar kun je een van de antwoorden selecteren maar geen vergelijking kan invoeren). Wees voorzichtig, want LimeSurvey kan niet valideren dat je vergelijking een goed antwoord voor die vraag oplevert.
Je wilt het antwoord van een vorige vraag aanpassen op grond van een later gegeven antwoord.
enz.

Attentie : De toekenning wordt alleen in PHP gedaan. Dit betekent dat de waarde niet op dezelfde pagina wordt bijgewerkt, maar pas wanneer de gebruiker naar een andere pagina gaat. Let daarom op wanneer de operator op dezelfde pagina wordt gebruikt met andere expressies.

Je kunt voor dit doel ExpressionScript gebruiken, maar het is beter om het vraagtype vergelijking te gebruiken.

Voorbeeld:

Zet het antwoord op een korte tekstvraag in kleine letters : {QCODE=strtolower(QCODE.NAOK)}
Zet een standaardantwoord voor het vraagtype array bij het starten van de enquête : {Q1_SQ1=(is_empty(Q1_SQ1.NAOK),"A99",Q1_SQ1.NAOK)}
Zet een standaardantwoord voor het vraagtype array (tekst) bij het begin van de enquête : {Q1_SQY1_SQX1 = (is_empty(Q1_SQY1_SQX1.NAOK),"Inserted answer", Q1_SQY1_SQX1.NAOK)}
Zet een conditie op een antwoord: {QCODE=if(YesNo="Y","A1","")}

XSS beveiliging

Als XSS is ingeschakeld kunnen enkele delen van ExpressionScript niet worden gebruikt:

een HTML-tag in een expressie laten starten en in een andere afsluiten.
een URL in de expressie.

NB: standaard iS XSS ingeschakeld!

Voorbeeld en alternatief

{if( 1 ,"","")}information{if( 1, "","")} is gebroken met XSS-beveiliging, je kunt hier gebruiken {if(1,"information","information")}
<a href="/script.php?value={if(QCODE == "Y","yes","no")}">next</a>, hier kun je een vergelijkingsvraag gebruiken omdat een het gebruik van een volledige vraagcode is toegestaan : <a href="/script.php?value={EQUATION.NAOK}">next</a>

Toegang tot variabelen

ExpressionScript geeft alleen leesrecht op de beschikbare variabelen. Om voorgaande versies te blijven ondersteunen, is er toegang tot:

TOKEN:xxx - de waarde van een TOKEN (bijvoorbeeld TOKEN:FIRSTNAME (voornaam), TOKEN:ATTRIBUTE_5 (attribuut_5)) (Alleen voor NIET anonieme enquêtes.)
INSERTANS:SGQA - de te tonen waarde van een antwoord, bijvoorbeeld "Ja". Gelijk aan het gebruik van {QCODE.shown}.
Alle {XXX} waarden gebruikt in sjablonen
In de vraagtekst, kun je {QID} gebruiken voor het ID van de vraag en {SGQ} voor de SGQA van de vraag.

Je kunt in ExpressionScript ook refereren aan de vragen met de vraagcode (de kolom 'titel' in de database-table questions). Dit is ook het label dat bij het exporteren van gegevens naar SPSS, R en SAS wordt gebruikt. Als je een vraag hebt over naam, leeftijd en geslacht dan kun je die variabelen ook "naam", "leeftijd" en "geslacht"noemen en niet 12345X13X22, 12345X13X23 en 12345X13X24. Dat maakt het lezen van vergelijkingen fijner en het valideren duidelijker, ook is het verplaatsen van vragen eenvoudiger omdat je niet meer afhankelijk bent van volgnummertjes van een vraag of groep.

Belangrijk: Het is veiliger om alleen variabelen te gebruiken die op voorgaande pagina's of vragen aangemaakt zijn.

Je kunt verder nog de eigenschappen van de vraag lezen:

Syntax	Betekenis	Voorbeeld	Resultaat
Qcode	alias voor Qcode.code	{implode(',',name,gender)}	'Tom','M'
Qcode.code	de geselecteerde antwoordcode bij de vraag als die relevant is (anders leeg) of de tekstwaarde als het geen gecodeerde vraag is	{implode(',',name.code,gender.code)}	'Tom','M'
Qcode.NAOK	als Qcode : zie discussie bij NAOK	{gender.NAOK}	'M'
Qcode.value	de beoordelingswaarde voor de vraag als die relevant is (anders leeg) of de tekstwaarde als het geen gecodeerde vraag is	{gender.value}	'1'
Qcode.valueNAOK	als Qcode.value : zie discussie bij NAOK	{gender.valueNAOK}	'1'
Qcode.shown	de getoonde waarde bij de vraag	{implode(',',name.shown,gender.shown)}	'Tom','Male'
Qcode.question	de vraagtekst	{gender.question}	'What is your gender?'
Qcode.mandatory	of de vraag verplicht is (Y/N)	{gender.mandatory}	'N'
Qcode.qid	interne vraagnummer (niet het volgnummer)	{gender.qid}	337
Qcode.type	het vraagtype	{gender.type}	'G'
Qcode.jsName	de JavaScript naam van de vraag, ongeacht of die op deze pagina is gedeclareerd	{gender.jsName}	'java1827X3X337'
Qcode.gid	interne groepsnummer (niet het volgnummer)	{gender.gid}	3
Qcode.qseq	het volgnummer van de vraag, beginnend met 0	{gender.qseq}	5
Qcode.gseq	het volgnummer van de groep, beginnend met 0	{gender.gseq}	1
Qcode.relevanceStatus	is de vraag nu relevant (0 of 1)	{gender.relevanceStatus}	1
Qcode.relevance	de relevantievergelijking van de vraag	{gender.relevance}	'!is_empty(name)'
Qcode.grelevance	de relevantievergelijking van de groep	{gender.grelevance}	'num_children >= 5'
Qcode.sgqa	de SGQA-code van de vraag	{gender.sgqa}	'1827X3X337'

HTML-editor probleem

Als je de HTML-editor gebruikt worden sommige tekens vervangen door HTML.

& door &
< door <
> door >

Als je de HTML-editor gebruikt, gebruik dan:

and voor &
lt voor <
le voor <=
gt voor >
ge voor >=

Wij raden aan dat je in je expressie geen HTML gebruikt. Als je de LimeSurvey HTML-editor gebruikt, klik dan op de knop "Source" (linksboven) en verwijder alle tekens die niet bij je expressie horen (bijv.:

,
, ...).

Naamgeving Qcode Variabele

Dit zijn de details per vraagtype die je nodig hebt om een Qcode te maken (en enkele eigenschappen te benaderen). In het algemeen worden Qcodes samengesteld als volgt:

 VraagCode . '_' . SubvraagID . '_' . SchaalId

Voor commentaar en anders zijn de overeenkomende vraagcodes resp. VraagCode_comment en VraagCode_other.

Type	Beschrijving	Code	Subvraag	Antwoordopties	Schalen	Antwoordcode	Antwoord getoond	Relevantie
5	5-puntskeuze	Q1		1-5		{Q1}	{Q1.shown}	{Q1==3}
B	Array (10-puntskeuze)	Q2	L1-L6	1-10		{Q2_L2}	{Q2_L2.shown}	{Q2_L2==7}
A	Array (5-puntskeuze)	Q3	1-5	1-5		{Q3_1}	{Q3_1.shown}	{Q3_1>=3}
1	Array dubbele schaal	Q4	sq1-sq5	0:a1-a3	1:b1-b3	{Q4_sq1_0}	{Q4_sq1_1.shown}	{Q4_sq1_1=='b2'}
H	Array - kolommen	Q5	1-5	s,m,t		{Q5_1}	{Q5_1.shown}	{Q5_1=='s'}
F	Array - rijen	Q6	F1-F5	1-5		{Q6_F3}	{Q6_F3.shown}	{Q6_F3==4}
E	Array (Meer/Gelijk/Minder)	Q7	1-7	I,S,D		{Q7_4}	{Q7_4.shown}	{Q7_4=='D'}
:	Array (getallen)	Q8	ls1,todo,ls2	min,max,avg		{Q8_ls1_max}	{Q8_ls2_avg.shown}	{Q8_ls2_min==7}
;	Array (teksten)	Q9	hp,st,sw	1st,2nd,3rd		{Q9_hp_3rd}	{Q9_hp_3rd.shown}	{Q9_hp_3rd=='Peter'}
C	Array (Ja/Nee/Weet niet)	Q10	1-5	Y,N,U		{Q10_1}	{Q10_1.shown}	{Q10_3=='Y'}
X	Boilerplate	Q11					{Q11.shown}
D	Datum	Q12				{Q12}	{Q12.shown}
*	Vergelijking	Q13				{Q13}	{Q13.shown}	{Q13>5}
~124~	Bestandsupload	Q14				{Q14}		{Q14>0}
G	Geslacht	Q15		M,F		{Q15}	{Q15.shown}	{Q15=='M'}
U	Extra lange vrije tekst	Q16				{Q16}	{Q16.shown}	{strlen(Q16)>100}
I	Taalkeuze	Q17				{Q17}	{Q17.shown}	{Q17=='en'}
!	Lijst (Dropdown)	Q18		1-5		{Q18}	{Q18.shown}	{Q18==3}
L	Lijst (Dropdown) / Radioknoppen	Q19		A-Z		{Q19}	{Q19.shown}	{Q19=='X'}
O	Lijst (Dropdown) met opmerkingen	Q20		A-F		{Q20},{Q20comment}	{Q20.shown}	{Q20=='B'}
T	Lange vrij tekst	Q21				{Q21}	{Q21.shown}	{strstr(Q21,'hello')>0}
M	Meerkeuzevraag	Q22	A-F, other			{Q22_E}, {Q22_other}	{Q22_E.shown}, {Q22_other.shown}	{Q22_E=='Y'}
P	Meerkeuzevraag met opmerkingen	Q23	A-F			{Q23_D}, {Q23_Dcomment}	{Q23_D.shown}	{!is_empty(Q23)}
K	Meervoudige numerieke invoer	Q24	self,mom,dad			{Q24_self}	{Q24_self.shown}	{Q24_self>30}
Q	Meerkeuzevraag met opmerkingen	Q25	A-F			{Q25_B}	{Q25_B.shown}	{substr(Q25_B,1,1)=='Q'}
N	Numerieke invoer	Q26				{Q26}	{Q26.shown}	{Q26 > 30}
R	Rangschikken	Q27	1-4			{Q27_1}	{Q27_1.shown}	{Q27_1==3}
S	Korte vrije tekst	Q28				{Q28}	{Q28.shown}	{Q28=='mine'}
Y	Ja/Nee Radioknoppen	Q29				{Q29}	{Q29.shown}	{Q29=='Y'}

Het gebruik van NAOK

NAOK --> "Not Applicable" (Niet van toepassing) is OK (goed)

Bij gebruik van NAOK zijn sommige variabelen niet meer van belang, ("Not Applicable OK").

Voorbeeld : count(Q1_SQ1,Q1_SQ2,Q1_SQ3,Q1_SQ4) geeft altijd een lege string als een subvraag van Q1 wordt gefilterd. Om het aantal gecontroleerde subvragen in dergelijke vraag te tellen: count(Q1_SQ1.NAOK,Q1_SQ2.NAOK,Q1_SQ3.NAOK,Q1_SQ4.NAOK). Indien de subvraag is verborgen heeft ExpressionScript een lege string terug.

Zonder NAOK : als een vraag of een subvraag is verborgen, geeft ExpressionScript een lege string terug, dat komt overeen met false.

Bij .shown wordt altijd het NAOK-systeem gebruikt (lege string als verborgen). Als u de antwoordcode wilt hebben, is het altijd goed om .NAOK toe te voegen aan de vraagcode.

Meer informatie over overriding trapsgewijze condities.

Gereserveerde variabelen ('this','self','that')

Je wilt vrij vaak alle delen van een vraag evalueren, zoals hoeveel subvragen zijn beantwoord of de totalen van de scores bepalen. Soms wil je alleen bepaalde rijen of kolommen verwerken van een vraag (bepalen van de som van een rij en kolom en dat getal opslaan in de database). De gereserveerde variabelen vereenvoudigen dat.

"This" variabele

De "this" variabele wordt alleen gebruikt in de opties "hele vraag validatievergelijking" en "subvraag validatievergelijking" (de laatste kan niet via de GUI). Het wordt geëxpandeerd naar de variabele-namen voor elke cel binnen die vergelijkingen. Als je dus wilt controleren of elke invoer groter dan drie is, dan kun je de "Subvraag validatievergelijking" zetten op (this > 3).

"Self" variabele

De "self" en "that" variabele zijn krachtiger, ze zijn macro's die uitgevoerd worden voordat de vergelijkingen verwerkt worden. De syntax is:

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

suffix is een van de normale qcode achtervoegsels (NAOK, value, shown)

sub-selector kan een van het volgende zijn:

commentaar : alleen subvragen met commentaar (bijv., meerkeuzevraag met opmerkingen en lijst met opmerkingen)
geen opmerkingen : alleen subvragen die geen opmerkingen zijn
sq_X : waar X is een rij of kolom identifier. Alleen subvragen die overeenkomen met patroon X worden geselecteerd. Als de zoek is gedaan op gehele code dan worden ook de subvragen gevonden nX, X, Xn (als je gebruikt sq_1, subvragen a1, 1a, 1, 11 of 001 zijn toegevoegd). Bij het vraagtype dubbele schaal is de subvraagcodes zijn QCODE_SQCODE_1 en QCODE_SQCODE_1 en bij vraagtype rangschikken QCODE_1,QCODE_2 ....

Voorbeelden:

Is elk deel van de vraag beantwoord? {count(self.NAOK)>0}
Wat is de beoordelingsscore voor deze vraag? {sum(self.value)}

Je kunt dit ook gebruiken om rij- en kolomtotalen te bepalen. Stel je hebt een array met rijen A-E en kolommen 1-5.

Wat is het totaal? {sum(self.NAOK)}
Wat is het totaal van rij B? {sum(self.sq_B.NAOK)}
Wat is het totaal van kolom 3? {sum(self.sq_3.NAOK)}

"That" variabele

De "that" variabele is als de "self" variabele, maar je kunt refereren aan andere vragen. De syntax is:

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

qname is de naam van de vraag zonder de extensie van een subvraag. Dus als een je vraag 'q1' hebt, dan is dat de qname.

Voorbeelden:

Is elk deel van de vraag q1 beantwoord? {count(that.q1.NAOK)>0}
Wat is de beoordelingsscore voor q2? {sum(that.q2.NAOK)}
Wat is het totaal van q3? {sum(that.q3.NAOK)}
Wat is het totaal van rij C in q4? {sum(that.q4.sq_C.NAOK)}
Wat is het totaal van kolom 2 in q4? {sum(that.q4.sq_2.NAOK)}

De self en that variabelen kunnen worden gebruikt in elke relevantie, validatie of maatwerk.

De valkuil is dat als je toon logica bestand gebruikt, je dan de geëxpandeerde waarde ziet van "self" en "that". Je ziet dan dus de actuele vergelijking die gegenereerd wordt zodat je (en EM) kunt valideren of de variabelen bestaan. Omdat je dan hele lange vergelijkingen kunt zien, kan dat verwarrend zijn. Als je de vraag gaat wijzigen, zie je wel de originele vergelijking met de variabelen "self" en/of "that".

Je moet deze variabelen niet gebruiken als je

expliciet elke variabele in de vergelijking wilt benoemen, of
variabelen gebruikt zonder subvragen.

In die gevallen is het gebruik van 'that' wat nutteloos, en loop je het risico op onverwachte resultaten.

Toegang tot functies

ExpressionScript ondersteunt het gebruik van de onderstaande functies inclusief door de gebruiker gedefinieerde functies. Je kunt dus zelf functies toevoegen. Het heeft PHP en JavaScript tegenhangers voor de onderstaande functies, zodat ze op de server (PHP) en de cliënt (JavaScript) gelijk werken. Je kunt eenvoudig functies toevoegen.

Geïmplementeerde functies

De volgende functies zijn beschikbaar:

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)

Klik hier voor een uitleg over functies die nog ontwikkeld worden (of worden overwogen).

Functie in expressie aanmaken met plugin ^{(Nieuw in 4.0.0)}

Als je een functie in een expressie nodig hebt die nog niet bestaat dan kun je deze zelf aanmaken met een plugin. Hiervoor is het event expressionManagerStart beschikbaar.

ExpressieScript weet wat de lokale variabelen zijn

Om de JavaScript op een pagina goed op te bouwen, moet EM weten welke variabelen op de pagina staan en wat hun JavaScript-id is (bijvoorbeeld voor document.getElementById(x)). Het moet ook weten welke variabelen op andere pagina's worden gebruikt (zodat het zeker is dat de nodige <input type='hidden' value='x'> velden aanwezig en gevuld zijn).

Trapsgewijze condities

Als een van de variabelen niet relevant is, wordt de hele vergelijking niet relevant (false). Bijvoorbeeld, in de onderstaande tabel betekent N/A dat een van de variabelen niet relevant was.

Operator	Voorbeeld	a	b	Resultaat
+ (unary)	+a	N/A		false
!	!a	N/A		false
== (of eq)	a == b	N/A	5	false
== (of eq)	a == b	N/A	0	false
== (of eq)	a == b	N/A	N/A	false
!= (of ne)	a != b	N/A	5	false
!= (of ne)	a != b	N/A	N/A	false
!= (of ne)	a != b	N/A	0	false
> (of gt)	a > b	N/A	5	false
>= (of ge)	a >= b	N/A	5	false
< (of lt)	a < b	N/A	5	false
<= (of 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
functie	sum(a,b,b)	N/A	5	false
functie	max(a,b)	N/A	5	false
functie	min(a,b)	N/A	5	false
functie	implode(', ',a,b,a,b)	N/A	5	false
functie	if(a,a,b)	N/A	5	false
functie	is_empty(a)	N/A		false
functie	is_empty(a)	0 (of leeg)		true
functie	!is_empty(a)	N/A		false

Overslaan trapsgewijze condities

Stel je wilt een lopend totaal tonen van alle relevante antwoorden. Je kunt de vergelijking {sum(q1,q2,q3,...,qN)} proberen. Echter dit wordt intern vertaald naar LEMif(LEManyNA('q1','q2','q3',...,'qN'),,sum(LEMval('q1'),LEMval('q2'),LEMval('q3'),...,LEMval('qN'))). Dus als een van de waarden q1-qN niet relevant is, krijg je altijd als resultaat false. De sum() is zolang niet alle vragen zijn beantwoord altijd 0.

Om dit probleem te voorkomen, kan elke variabele een achtervoegsel ".NAOK" krijgen (dat betekent dat niet toepasbaar goed is Not Applicable is OK). Dat leidt dan tot het volgende gedrag. Stel je hebt een variabele q1.NAOK

q1 wordt niet toegevoegd aan de LEManyNA() clause
LEMval('q1') blijft controleren of het antwoord relevant is en geeft "" terug als het niet relevant is (dus individuele niet relevante antwoorden worden overgeslagen, maar ze hebben geen invloed op de gehele expressie).

Dus de te gebruiken vergelijking voor het lopende totaal is: sum(q1.NAOK,q2.NAOK,q3.NAOK,...,qN.NAOK).

Met het gebruik van de suffix NAOK kun je een enquête ontwerpen die meerdere mogelijke paden heeft die later weer samenkomen. Stel dat onderwerpen in een enquête op een onverwachte manier worden ingevuld. Je kunt dan aangeven als maker aan de gebruiker dat er een vreemd resultaat is en ze vragen of ze door willen gaan met invullen. Als ze door willen gaan dan gaat de enquête natuurlijk door. De conditie voor de overige vragen worden dan gecontroleerd of de antwoorden binnen de verwachte antwoorden vallen OF dat er sprake is van een vraag die afhankelijk is van de vraag die 'doorgedrukt' is.

Hoe wordt conditioneel micro-maatwerk ondersteund?

Dit is een voorbeeld van micro-maatwerk (waar Vraagtype == 'expr' betekent als het vraagtype vergelijking is):

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}

Bovenstaand voorbeeld in het Engels met aantal kinderen downloaden.

Al deze vragen kunnen op dezelfde pagina (dus in een groep), alleen de relevante vragen worden getoond. Bovendien wordt, als de leeftijden van de kinderen worden ingevoerd, de sum() expressie in de laatste vraag dynamisch op de pagina gewijzigd.

ExpressionScript zorgt voor deze functionaliteit door elke expressie in een element met een bepaalde naam te zetten. Elke keer als een waarde wijzigt wordt de expressie in dat element opnieuw bepaald. Er is geen beperking in het aantal van dergelijke micro-maatwerk expressies op een pagina.

Syntax markeren

Als ondersteuning bij het invoeren en valideren van expressies wordt de syntax met kleur gemarkeerd volgens de regels:

Manieren van markeren en hun betekenis

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.

Met tooltips bedoelen we de tekst die in een pop-up getoond wordt als je met de muis over bepaalde functies en variabelen heen gaat.

@@ Line 787: / Line 787: @@
 Dus de te gebruiken vergelijking voor het lopende totaal is:  '''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.
+Met het gebruik van de suffix NAOK kun je een enquête ontwerpen die meerdere mogelijke paden heeft die later weer samenkomen. Stel dat onderwerpen in een enquête op een onverwachte manier worden ingevuld. Je kunt dan aangeven als maker aan de gebruiker dat er een vreemd resultaat is en ze vragen of ze door willen gaan met invullen. Als ze door willen gaan dan gaat de enquête natuurlijk door. De conditie voor de overige vragen worden dan gecontroleerd of de antwoorden binnen de verwachte antwoorden vallen OF dat er sprake is van een vraag die afhankelijk is van de vraag die 'doorgedrukt' is.
 =Hoe wordt conditioneel  micro-maatwerk ondersteund?=

ExpressionScript - Presentation/nl: Difference between revisions

From LimeSurvey Manual