PHP-Funktionen

Dieses Kapitel stellt die Funktionen vor, die in PHP-Code Elementen zur Verwendung stehen. Die Einführung in PHP-Code erklärt, wie man PHP-Funktionen im Fragebogen einsetzen kann.

Ganz unten auf dieser Seite wird erläutert, wie die Dokumentation der einzelnen PHP-Funktionen zu lesen ist: Funktionen im Detail

Siehe auch Filterfragen und Filter.

• value() – Eine Antwort des Befragten verwenden, z.B. für Filter
• goToPage() – Zu einer anderen Seite springen
  • goToPage('end') – Interview beenden
• repeatPage() – Die letzte Seite erneut anzeigen
• redirect() – Den Befragten zu einer anderen Website weiterleiten
• question() – Eine Frage im Fragebogen anzeigen
• text() – Text oder HTML-Code innerhalb des Fragebogens anzeigen
• show() – Eine Frage, kombinierte Frage oder Text anzeigen
• debug() – Inhalt einer Daten- oder PHP-Variable anzeigen

• option() – Darstellung der Seite anpassen (u.a. Fortschrittsanzeige, Weiter-Button)
• preset() – Antwort für eine Frage vorgeben
• markFail() – Für ein Eingabefeld die Markierung „Antwort fehlt“ setzen
• html() – Direkt HTML-Code innerhalb des Fragebogens ausgeben
• textlink() – Link auf einen Fragebogen-Text berechnen
• buttonToPage() – Knopf, um innerhalb des Fragebogens zu springen
• buttonCode() – HTML-Code für den Knopf „Weiter“ oder „Zurück“ erzeugen
• buttonHide() – Weiter- und Zurück-Knopf deaktivieren
• library() – JavaScript- oder PHP-Bibliothek einbinden
• pageCSS() – CSS-Anweisungen für eine einzelne Fragebogen-Seite
• pageHead() – Meta-Informationen zur Fragebogen-Seite hinterlegen

SoSci Survey bietet verschiedene Funktionen für spezielle Zufallsauswahlen und zufällige Gruppeneinteilungen. Für eine einfache experimentelle Variation empfehlen wir einen Zufallsgenerator (Randomisierung).

• put() – Wert im Datensatz abspeichern
• random() – Zufallszahl würfeln
• random_p() – Zufallszahl unter Vorgabe von Wahrscheinlichkeiten
• random_items() – Zufällig Items aus einer Liste auswählen
• randomUse() – Zettel eines Zufallsgenerators gezielt ablegen
• urnDraw() – Zieht einen Zettel aus einer Urne (Zufallsauswahl ohne Zurücklegen)
• urnPutAway() – Entfernt einen mit urnDraw() gezogenen Zettel aus der Urne
• urnStatus() – Aktuellen Status einer Urne auslesen

• replace() – Einen Platzhalter vorbereiten
• registerVariable() – PHP-Variable für die Verwendung auf weiteren Seiten registrieren
• id() – Frage- oder Item-Kennung aus Einzelangaben erstellen
• getItems() – Listet die Items einer Frage nach bestimmten Kriterien auf
• getQuestions() – Listet die Fragen einer Rubrik auf
• getItemtext() – Beschriftung eines Items oder einer Antwortoption abfragen
• getValueText() – Beschriftung einer Antwortoption abfragen
• getTextElement() – Inhalt eines Textbausteins auslesen
• getVariables() – Liefert eine Liste von Variablen as dem Datensatz
• getRoute() – Ermitteln, ob der Weiter- oder Zurück-Knopf verwendet wurde
• caseNumber() – Nummer der aktuellen Interviews
• caseSerial() – Teilnahmecode oder Personenkennung der Teilnehmer:in
• caseTime() – Verweildauer auf einer oder mehreren Seiten
• caseToken() – Interne Kennung des Interviews
• caseData() – Alle im Interview erhobenen Daten ermitteln
• reference() – Evtl. im Link zum Fragebogen übergebene Referenz abfragen
• serialCheck() – Status eines Teilnahmecodes abfragen
• readGET() – Eine übertragene Variable aus dem Link auslesen
• sendJSON() – HTTP-Anfrage im JSON-Format senden (REST API)
• sendPOST() – HTTP-Anfrage im POST-Format senden (REST API)
• sendXML() – HTTP-Anfrage im XML-Format senden (REST API)
• getAnswerMissing() - Information ob die Seite wegen einer Pflichtfrage wiederholt wird
• listFails() – Liste der nicht ausgefüllten Pflichtfragen
• setNextPage() – Seite nach dem Weiter-Klick festlegen
• setPageOrder() – Abfolge der Seiten im Fragebogen festlegen
• loopPage() – Eine Seite mehrfach in einer Schleife anzeigen
• loopToPage() – Mehrere Seiten mehrfach in einer Schleife anzeigen
• pageStop() – Keine weiteren Inhalte auf der Seite anzeigen
• getLanguage() – Aktuelle Sprachversion ermitteln
• setLanguage() – Sprachversion ändern
• buttonDataCode() – Knopf auf der Seite einfügen und mit Daten verknüpfen
• buttonDataGet() – Die über einen mittels buttonDataCode() erstellen Knopf übermittelten Daten abrufen

• goToQuestionnaire() – Von einem Fragebogen zu einem anderen springen (einmalig)
• goToParent() – Zum ursprünglichen Fragebogen zurückkehren
• multiLevelDown() – Einen Teilfragebogen innerhalb des Hauptfragebogens starten (ggf. auch mehrmals)
• multiLevelData() – Daten ermitteln, die in multiLevelDown() angegeben wurden
• multiLevelReturn() – Rückkehr vom Teilfragebogen zum Hauptfragebogen
• multiLevelResponse() – Daten ermitteln, die in multiLevelReturn() angegeben wurden
• multiLevelPut() – Einen Wert direkt im übergeordneten Datensatz abspeichern
• multiLevelURL() – Eine URL für einen Teilfragebogen erzeugen zum späteren Wechsel in den neuen Fall
• multiLevelPrepare() – Einen untergeordneten Fall erstellen und mit Werten vorbelegen, zur Verwendung mit einer Multi-Level-Übersicht

• dbGet() – Daten aus der Datenbank für Inhalte abrufen (indiziertes Array)
• dbKeys() – Schlüssel aus der Datenbank für Inhalte auflisten
• dbLoad() – Alle Einträge mit einem definierten Präfix aus der Datenbank für Inhalte abrufen
• dbRetrieve() – Daten aus der Datenbank für Inhalte abrufen (assoziatives, verschachteltes Array)
• dbSet() – Daten in der Datenbank für Inhalte abspeichern (indiziertes Array)
• dbStore() – Daten in der Datenbank für Inhalte abspeichern (assoziatives, verschachteltes Array)
• dbTouch() – Zeitstempel für einen Eintrag in der Datenbank aktualisieren

• dropValue() – Eine einzelne Variable aus dem aktuellen Interview löschen
• dropCase() – Das aktuelle Interview zum Löschen vormerken
• dropHistory() – Die Seiten-Historie des aktuellen Interviews löschen

• statistic() – Einfache statistische Auswertung über alle erhobenen Daten
• diagram() – Einfaches Diagramm (z.B. Häufigkeiten) über alle erhobenen Daten

• answers() – Frage mit Antworten des Befragten anzeigen
• answersOption() – Darstellung der Antworten in answers() oder answersPrint() anpassen
• answersPrint() – Alle Fragen eines Fragebogen-Abschnitts inkl. Antworten des Befragten anzeigen
• info() – Metainformationen zum aktuellen Interview oder zur Darstellung
• valueSum() – Summe über eine Skala oder mehrere Variablen berechnen
• valueMean() – Mittelwert über Skala oder Variablen berechnen
• valueSD() – Standardabweichung über Skala oder Variablen berechnen
• valueVar() – Varianz über Skala oder Variablen berechnen
• valueList() – Mehreren Item-Antworten einer Frage als Array abrufen
• convertDateTime() – Zeitangaben und Zeitstempel ineinander umwandeln
• calcMean(), calcSD(), ... – Einfache Berechnungen

• diagram2() – Diagramm mit vorgegeben Daten erstellen
• getQRCodeImage() – QR-Code im Fragebogen einbinden
• imagepng_embed() – PNG-Grafik ohne Umweg über eine Datei einbinden

• mailResume() – Zeitverzögerte Fortsetzung des Interviews
• mailSchedule() – Den zeitgesteuerten Versand einer Serienmail an einen einzelnen Teilnehmer vorbereiten
• mailRevoke() – Fortsetzungsmail(s) oder Serienmail stornieren
• mailSend() – E-Mail an eine Adresse versenden, die nicht in der Adressliste steht
• panelData() – Informationen zum Adresseintrag abrufen

Weiterhin stellt PHP selbst zahlreiche Funktionen bereit, von denen einige im Fragebogen sehr hilfreich sein können. Diese Funktionen sind im PHP Manual dokumentiert.

• Generell nützliche Funktionen
  • implode - Array-Elemente zu einem String zusammenfügen
  • explode - Einen String in ein Array zerlegen
  • preg_split - String mittels regulärem Ausdruck in Array zerlegen
• Mathematische Funktionen
  • round - Kommazahl runden
  • ceil - Zahl aufrunden
  • floor - Zahl abrunden
  • abs - Betrag einer Zahl ermitteln
• Array-Funktionen
  • array_diff - Array-Elemente subtrahieren
  • array_fill - Array mit (gleichen) Werten füllen
  • array_flip - In einem Array Schlüssel und Werte vertauschen
  • array_intersect - Schnittmenge zwischen Arrays
  • array_keys - Schlüssel eines Arrays ermitteln
  • array_key_exists - Prüfen, ob in einem Array ein Schlüssel existiert
  • array_merge - Arrays zusammenfügen
  • array_pop - Letztes Element eines Arrays entfernen und ausgeben
  • array_push - Element(e) am Ende eines Arrays einfügen
  • array_rand - Ein oder mehrere Einträge eines Arrays zufällig auswählen
  • array_reverse - Array in umgekehter Reihenfolge liefern
  • array_search - Array nach einem Wert durchsuchen
  • array_shift - Element vom Anfang eines Arrays abschneiden und ausgeben
  • array_slice - Einen Ausschnitt eines Arrays in ein neues Array schreiben
  • array_sum - Elemente in einem Array aufsummieren
  • array_unique - Doppelte Elemente aus einem Array entfernen
  • array_unshift - Wert(e) am Anfang des Arrays einfügen
  • array_values - Assoziatives in indiziertes Array umwandeln
  • arsort - Array absteigend sortieren und Schlüssel beibehalten
  • asort - Array aufsteigend sortieren und Schlüssel beibehalten
  • count - Anzahl der Elemente in einem Array ausgeben
  • in_array - Prüfen, ob ein Wert in einem Array vorkommt
  • is_array - Prüfen, ob eine Variable ein Array ist
  • krsort - Array absteigend nach Schlüssel sortieren
  • ksort - Array aufsteigend nach Schlüssel sortieren
  • list - Array auf mehrere Variablen verteilen
  • rsort - Array absteigend sortieren
  • shuffle - Array zufällig mischen
  • sort - Array aufsteigend sortieren
• Datum und Zeit
  • date - Zeitstempel als Datumsangabe formatieren
  • mktime - Zeitangabe in einen Zeitstempel umrechnen
  • microtime - Zeitstempel mit Mikrosekunden ausgeben
  • time - Zeitstempel in Sekunden ausgeben
• String-Bearbeitung
  • htmlentities - Alle Zeichen, die eine HTML-Entitäs besitzen in selbige umwandeln
  • htmlspecialchars - HTML-Syntaxt-Zeichen (Anführungszeichen, spitze Klammern) in HTML-Entitäten umwandeln
  • ltrim - Leerraum an Anfang eines Strings entfernen
  • number_format - Eine Zahl mit Nachkommastellen und/oder Tausenderpunkt formatieren
  • rtrim - Leerraum an Ende eines Strings entfernen
  • str_pad - String mit Füllzeichen auf eine bestimmte Länge auffüllen
  • str_replace - Teilstring Suchen und Ersetzen
  • strlen - Länge eines Strings ermitteln
  • strtolower - String in Kleinbuchstaben umwandeln
  • strtoupper - String in Großbuchstaben umwandeln
  • substr_count - Häufigkeit eines Teilstrings auszählen
  • substr - Teilstring ermitteln
  • trim - Leerzeichen am Anfang und Ende entfernen
  • Weiterhin erlaubt sind die Funktionen: nl2br, str_repeat, str_shuffle, str_word_count, strip_tags, stripos, stristr, strpos, strrev, strripos, strrpos, strstr, substr_replace, wordwrap
    
• Bilder zeichnen (z.B. Diagramme)
  • imagecolorallocate - Farbe für Grafik verwenden
  • imagecreate - Neues Bild erzeugen
  • imagecreatetruecolor - Neues Bild in Echtfarben (16 Mio.) erzeichen
  • imageellipse - Ellipse oder Kreis zeichnen
  • imagefill - Bild(bereich) mit Farbe füllen
  • imagefilledarc - Gefüllten Kreissektor zeichnen
  • imagefilledellipse - Gefüllte Ellipse oder Kreis zeichnen
  • imagefilledpolygon - Gefülltes Polygon zeichnen
  • imagefilledrectangle - Gefülltes Rechteck zeichen
  • imagefilltoborder - Bild bis zu einer Linie mit einer Farbe füllen
  • imageline - Gerade Linie zeichnen
  • imagepolygon - Polygon zeichnen
  • imagerectangle - Rechteck zeichnen
  • imagesetbrush - Pinsel festlegen
  • imagesetpixel - Pixel zeichen
  • imagesetstyle - Stil für Linien festlegen
  • imagesetthickness - Breite von Linien festlegen
  • imagestring - Text zeichnen (horizontal)
  • Weiterhin erlaubt sind die Funktionen: image_type_to_extension, image_type_to_mime_type, imagearc, imagechar, imagecharup, imagecolorallocatealpha, imagecolorat, imagecolorclosest, imagecolorclosestalpha, imagecolorclosesthwb, imagecolordeallocate, imagecolorexact, imagecolorresolve, imagecolorset, imagecopy, imagecopymerge, imagecopymergegray, imagecopyresampled, imagecopyresized, imagedashedline, imagedestroy, imagefilter, imagefontheight, imagefontwidth, imageinterlace, imagepalettecopy, imagerotate, imagesavealpha, imagesettile, imagestringup, imagesx, imagesy, imagetruecolortopalette
  • Folgende Funktionen können in leicht modifizierter Form verwendet werden: imagepng, imagettftext, imagecreatefrompng
• Sonstiges
  • intval - Variable in einen Integer-Wert umwandeln
  • md5 - MD5-hash eines Wertes berechnen

Einige Funktionen stellen ein Sicherheitsrisiko dar oder funktionieren im Kontext des Fragebogens nicht wie erwartet. Nachfolgend sind Alternativen aufgeführt. Wenn Sie weitere Funktionen benötigen, teilen Sie es bitte SoSci Survey mit.

• echo
  • html()
  • text()
• mysqld_query()
  • Datenbank für Inhalte
  • datasetRetrieve()

Für die Funktionen ist jeweils eine Referenz-Syntax angegeben, zum Beispiel:

void set(mixed Wert, [string Speicherplatz])

In dieser Referenz-Syntax steht, welche Argumente eine Funktion erwartet und welchen Datentyp diese haben.

• Zu Anfang steht der Datentyp, den die Funktion zurückgibt. In diesem Fall void, das bedeutet, dass die Funktion nur etwas macht, aber keinen Wert zurückgibt.
• In Klammern stehen dann die Argumente. Optionale Argumente sind in eckigen Klammern angegeben. Die Funktion set() muss also mindestens ein Argument Wert haben und darf ein zweites Argument Speicherplatz nutzen.
• Vor den Argumenten steht jeweils wieder der Datentyp:
  • mixed bedeutet, dass unterschiedliche Datentypen erlaubt sind
  • int ist eine Zahl
  • string ist ein String, also ein Text, der in Anführungszeichen steht
  • array ist ein Array, also eine Liste von Werten (Arrays)