mitmario.dev

Die Suche

PHP Sandbox 3 Min Lesezeit 2 BeispieleLektion 6 von 8

Spätestens beim fünfzigsten Lesezeichen willst du tippen statt scrollen. Die letzte Funktion des Projekts ist deshalb eine Suche, und die besteht aus einer einzigen Abfrage.

Eine Suche ist ein LIKE

Suchen mit und ohne Platzhalter
<?php

declare(strict_types=1);

// Eine Suche ist eine Abfrage mit LIKE. Und sie ist die Stelle, an der ein
// zusammengeklebtes SQL am schnellsten auffliegt: Der Suchbegriff kommt
// wortwoertlich vom Besucher.

$db = new PDO("sqlite::memory:", null, null, [
    PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
]);

$db->exec("CREATE TABLE lesezeichen (id INTEGER PRIMARY KEY, titel TEXT NOT NULL)");
$db->exec("INSERT INTO lesezeichen (titel) VALUES
    ('Astro'), ('PHP-Handbuch'), ('O''Reilly'), ('Wikipedia')");

function geklebt(PDO $db, string $begriff): void
{
    try {
        $treffer = $db->query("SELECT titel FROM lesezeichen WHERE titel LIKE '%$begriff%'")->fetchAll();

        echo "  geklebt:      ", count($treffer), " Treffer\n";
    } catch (PDOException $fehler) {
        echo "  geklebt:      ", $fehler->getMessage(), "\n";
    }
}

function vorbereitet(PDO $db, string $begriff): void
{
    $abfrage = $db->prepare("SELECT titel FROM lesezeichen WHERE titel LIKE :s");
    $abfrage->execute([":s" => "%" . $begriff . "%"]);
    $treffer = $abfrage->fetchAll();

    echo "  vorbereitet:  ", count($treffer), " Treffer",
        $treffer === [] ? "" : " (" . implode(", ", array_column($treffer, "titel")) . ")", "\n";
}

foreach (["php", "PHP", "o'reilly", "xyz"] as $begriff) {
    echo "Gesucht wird nach \"", $begriff, "\":\n";
    geklebt($db, $begriff);
    vorbereitet($db, $begriff);
    echo "\n";
}

WHERE titel = 'php' findet nur, was genau so heißt. Bei einer Suche ist die Frage andersherum, nämlich welcher Titel diesen Teil enthält. Dafür gibt es LIKE und das Prozentzeichen, das für beliebig viele Zeichen steht. LIKE '%php%' findet PHP-Handbuch, und nebenbei ist es bei SQLite unempfindlich gegen Groß- und Kleinschreibung, jedenfalls für die Buchstaben ohne Umlaut.

Im ersten Beispiel stehen zwei Fassungen derselben Suche nebeneinander. Die eine klebt den Suchbegriff in die Abfrage, die andere gibt ihn als Wert mit. Bei php liefern beide dasselbe. Bei o'reilly liefert die geklebte Fassung near "reilly": syntax error, weil der Apostroph den Text im SQL beendet.

Das ist der Platzhalter aus dem Abschnitt über Datenbanken. Nirgends fliegt geklebtes SQL so schnell auf wie bei einer Suche. Der Begriff kommt Zeichen für Zeichen vom Besucher, und ein Name mit Apostroph reicht schon.

Prozent und Unterstrich

Prozent und Unterstrich
<?php

declare(strict_types=1);

// In einem LIKE-Muster bedeuten zwei Zeichen etwas: % steht fuer beliebig
// viele Zeichen, _ fuer genau eines. Wer sie eintippt, meint sie aber als
// Zeichen. Ein Platzhalter schuetzt davor nicht: Er schuetzt vor fremdem
// SQL, nicht vor fremden Jokern.

$db = new PDO("sqlite::memory:", null, null, [
    PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
]);

$db->exec("CREATE TABLE lesezeichen (id INTEGER PRIMARY KEY, titel TEXT NOT NULL)");
$db->exec("INSERT INTO lesezeichen (titel) VALUES
    ('Astro'), ('PHP-Handbuch'), ('Wikipedia'), ('50 % schneller')");

function fuerLike(string $begriff): string
{
    // Der Backslash zuerst, sonst verdoppelt der naechste Schritt genau
    // die Backslashes, die dieser hier erst erzeugt hat.
    return str_replace(["\\", "%", "_"], ["\\\\", "\\%", "\\_"], $begriff);
}

function suche(PDO $db, string $muster, bool $maskiert): array
{
    $sql = $maskiert
        ? "SELECT titel FROM lesezeichen WHERE titel LIKE :s ESCAPE '\\'"
        : "SELECT titel FROM lesezeichen WHERE titel LIKE :s";

    $abfrage = $db->prepare($sql);
    $abfrage->execute([":s" => "%" . ($maskiert ? fuerLike($muster) : $muster) . "%"]);

    return array_column($abfrage->fetchAll(), "titel");
}

echo str_pad("Eingetippt", 14), str_pad("roh durchgereicht", 20), "maskiert\n";
echo str_repeat("-", 60), "\n";

foreach (["php", "%", "_", "50 %"] as $begriff) {
    $roh = suche($db, $begriff, false);
    $sicher = suche($db, $begriff, true);

    echo str_pad('"' . $begriff . '"', 14),
        str_pad(count($roh) . " von 4", 20),
        count($sicher), " von 4",
        $sicher === [] ? "" : ": " . implode(", ", $sicher), "\n";
}

echo "\nOhne Maskierung treffen Prozent und Unterstrich also alles.\n";

In einem LIKE bedeuten zwei Zeichen etwas, % steht für beliebig viele Zeichen und _ für genau eines. Tippt jemand eines davon ins Suchfeld, meint er aber das Zeichen selbst. In der mittleren Spalte des zweiten Beispiels findet ein einzelner Unterstrich alle vier Einträge, ein einzelnes Prozentzeichen ebenfalls, und aus der Suche ist eine Anzeige aller Zeilen geworden.

Ein Platzhalter hilft dagegen nicht. Mit ihm bleibt der Wert zwar ein Wert und wird kein SQL. Ein Muster wird er trotzdem, denn er steht ja im Muster.

Der Ausweg heißt ESCAPE. Vor jedes besondere Zeichen kommt ein Escape-Zeichen. Mit ESCAPE '\' sagst du der Abfrage, welches das ist, und schon ist ein Prozentzeichen wieder ein Prozentzeichen. Das Escape-Zeichen selbst wird dabei mitmaskiert, sonst ließe es sich nicht mehr eintippen. Deshalb steht der Backslash in der Ersetzung an erster Stelle. Käme er zuletzt, würde er die Backslashes verdoppeln, die die Ersetzung vorher erst erzeugt hat.

Schlimm ist die Falle in diesem Projekt nicht. Die Abfrage sieht ohnehin nur die eigenen Zeilen. Wer % eintippt, bekommt ohne Maskierung eben seine ganze Liste statt der Titel mit einem Prozentzeichen. Falsch ist die Antwort trotzdem, nur merkt das erst, wer wirklich nach so einem Titel sucht.

Die Suche in der Anwendung

Das Suchfeld steht über der Liste, in einem Formular mit method="get". Der Begriff landet damit in der Adresse, als /suche?q=php, und du kannst eine Suche neu laden oder als Lesezeichen ablegen. Ein Token braucht sie nicht. Sie ändert nichts, und für ein GET gilt die Regel aus der Lektion über Bearbeiten und Löschen. Gibst du die Adresse weiter, gibst du auch nur den Begriff weiter. Welche Lesezeichen dabei herauskommen, hängt an der Sitzung, und tom findet unter /suche?q=php nichts.

seiteSuche() nimmt den Begriff aus $_GET, schneidet Leerzeichen am Rand ab und füllt dieselbe Vorlage wie die Liste, nur mit den Treffern und mit dem Begriff, der im Suchfeld wieder erscheint. Ein leerer Begriff kommt gar nicht erst bis zur Datenbank, und die Seite meldet „Keine Treffer.“

In der Aufgabe fehlen noch die zwei Methoden der Speicherklasse, die das Muster bauen und die Frage stellen.

Zum Mitnehmen

In einem LIKE-Muster steht % für beliebig viele Zeichen und _ für genau eines, und ein Platzhalter ändert daran nichts. Wer nach diesen Zeichen selbst suchen lassen will, setzt vor sie und vor das Escape-Zeichen einen Backslash und nennt ihn der Abfrage mit ESCAPE. Die Suche selbst ist ein GET, denn sie ändert nichts.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 2 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.