markFail()

void markFail(string VariablenKennung)

Die Funktion markFail() wird in Verbindung mit einer individuellen Antwortprüfung (Antworten prüfen: Individuelle Antwort-Prüfung) und der Funktion repeatPage() verwendet. Damit kann ein Eingabefeld so markiert werden, dass dem Teilnehmer erkennbar ist, wo die Angaben nicht korrekt sind.

• VariablenKennung
  Die Kennung einer Variable im Datensatz (s. Variablen-Übersicht).

Die Verwendung von markFail() hat zwei Effekte: Erstens wird das Eingabefeld optisch hervorgehoben und zweitens wird die Antwort bei der Berechnung der Variablen MISSING und MISSREL (Zusätzliche Variablen in der Datenausgabe) als fehlende Antwort gezählt. Letzteres ist vor allem dann relevant, wenn markFail() ohne repeatPage() verwendet wird.

Im folgenden Beispiel wird auf Seite 1 des Fragebogens abgefragt, wie viele Stunden und Minuten eine Person pro Tag fernsieht, und zwar mit den offenen Texteingabefeldern „AB01_01“ und „AB01_02“. Zusätzlich gibt es eine Mehrfachauswahl-Option „Ich sehe gar nicht fern“ mit der Kennung „AB02_01“.

Auf Seite 2 wird nun geprüft, ob in einem der Texteingabefelder etwas steht – oder ob das Auswahlfeld markiert ist. Wenn dies alles nicht zutrifft, wird die Seite erneut angezeigt, der Textbaustein „missing_tv“ als Fehlermeldung angezeigt und die Eingabefelder werden hervorgehoben.

if (
  (trim(value('AB01_01')) == '') and
  (trim(value('AB01_02')) == '') and
  (value('AB02_01') != 2)
) {
  markFail('AB01_01');
  markFail('AB01_02');
  repeatPage('missing_tv');
}

Auch hier werden Stunden, Minuten und eine Residualoption abgefragt wie in Beispiel 1. Diesmal allerdings in einer kombinierten Frage für 10 verschiedene Medienangebote. Die Stunden werden in der ersten Spalte (Frage „AC01“) abgefragt, die Minuten in der zweiten Spalte („AC02“) und als dritte Spalte muss eine Mehrfachauswahl „AC03“ herhalten.

Auf der folgenden (!) Seite wird nun mittels PHP-Code überprüft, ob in jeder Zeile eine Angabe gemacht oder das Auswahlfeld markiert wurde. Falls nicht, wird die Seite erneut angezeigt und die Zeilen mit fehlenden Angaben werden hervorgehoben.

$missing = false;
$items = getItems('AC01', 'all');
foreach ($items as $item) {
  $idH = id('AC01', $item);
  $idM = id('AC02', $item);
  $idX = id('AC03', $item);
  if ((trim(value($idH)) == '') and (trim(value($idM)) == '') and (value($idX) != 2)) {
    markFail($idH);
    markFail($idM);
    $missing = true;
  }
}
if ($missing) {
  repeatPage('zeitangabe');
}

Mitunter sollen die Fehlermeldungen genauer auf die fehlenden Variablen angepasst werden. Der folgende PHP-Code demonstriert, wie man die passenden Texte auswählt und die doppelte Anzeige vermeidet.

// Variablen und zugehörige Fehlertexte
$checks = [
  'AW01' => 'Text1',
  'AW02' => 'Text2',
  'AW03_01' => 'Text3',
  'AW03_02' => 'Text3',
  'AW03_03' => 'Text3',
  'AW03_04' => 'Text4',
  // u.s.w.
];
 
// Alle Variabeln überprüfen, markieren und Fehlermeldungen sammeln
$messages = [];
foreach ($checks as $variable => $text) {
  $antwort = value($variable);
  if ((trim($antwort) === '') || ($antwort < 1)) {
    markFail($variable);
    $messages[] = $text;
  }
}
 
// Ggf. Fehlermeldungen anzeigen und Seite wiederholen
if (!empty($messages)) {
  $messages = array_unique($messages);
  html('<div class="feedback" role="status">');  // Roter Rahmen
  foreach ($messages as $text) {
    text($text, 'spacing=10');
  }
  html('</div>');
  repeatPage();
}

Der PHP-Code besteht aus drei Teilen. Im ersten Teil werden in einem Array die zu prüfenden Variablen definiert und welche Fehlermeldung jeweils angezeigt werden soll, wenn die Variable nicht beantwortet wird.

Im zweiten Teil werden dann in einer FOR-Schleife alle Variablen einzeln geprüft. Das (trim($antwort) === '') ist nur erforderlich, wenn man auch Texteingaben prüfen möchte. Ansonsten prüft ($antwort < 1) auf einen Fehlercode. Nicht beantwortete Eingabefelder werden direkt mit markFail() markiert und die zur Fehlermeldung gehörige Text-Kennung wird in das Array $messages notiert.

Im dritten Teil wird dann geprüft, ob Meldungen im Array $messages vorliegen, doppelte werden mit array_unique() entfernt. Das <div> im HTML-Code sorgt für die Formatierung als Feedback-Meldung (z.B. markiert durch einen roten Rahmen) und innerhalb davon werden dann die Fehlermeldungen ausgegeben. Das repeatPage() schließlich sorgt für die erneute Anzeige der Seite.