4.3. Zend_Cache Frontends
Zurück | Kapitel 4. Zend_Cache | Weiter

## 4.3. Zend_Cache Frontends

### 4.3.1. Zend_Cache_Core

#### 4.3.1.1. Einführung

`Zend_Cache_Core` ist ein spezielles Frontend, da es der Kern dieses Moduls ist. Es ist ein generelles Cache Frontend und durch andere Klassen erweiterbar.

| Anmerkung
Alle Frontends sind von `Zend_Cache_Core` abgeleitet, so dass deren Methoden und Optionen (wie folgt beschrieben) auch in anderen Frontends vorhanden sind. Deswegen werden sie dort nicht dokumentiert.

#### 4.3.1.2. Mögliche Optionen

Diese Optionen werden der Factory Methode übergeben wie im nachfolgenden Beispiel demonstriert.

Tabelle 4.1. Mögliche Optionen

Option | Daten Typ | Standardwert | Beschreibung
--- | --- | --- | ---
`caching` | `boolean` | `true` | Ein- / Ausschalten vom Caching (kann sehr nützlich für das Debuggen von gecachten Skripten sein)
`lifeTime` | `int` | `3600` | Cache Lebensdauer (in Sekunden), wenn auf `null` gesetzt, ist der Cache für immer gültig.
`logging` | `boolean` | `false` | Wenn auf true gesetzt, wird das Logging durch `Zend_Log` aktiviert (aber das System wird langsamer)
`writeControl` | `boolean` | `true` | Ein- / Ausschalten der Schreibkontrolle (der Cace wird gleich gelesen, nachdem er geschrieben wurde, um fehlerhafte Einträge zu finden); das Einschalten der Schreibkontrolle wird das Schreiben des Caches etwas verlangsamen, aber nicht das Lesen des Caches (es können defekte Cache Dateien entdeckt werden, aber es ist keine perfekte Kontrolle)
`automaticSerialization` | `boolean` | `false` | Ein- / Ausschalten der automatischen Serialisierung, kann dafür benutzt werden, um Daten direkt zu speichern, welche keine Strings sind (aber es ist langsamer)
`automaticCleaningFactor` | `int` | `10` | Ausschalten / Abgleichen des automatischen Löschprozesses (Garbage Collector): 0 heißt keine automatische Löschung des Caches, 1 heißt Systematische Cache Löschung und x > 1 heißt automatisches zufälliges Löschen 1 mal nach x Schreiboperationen.

#### 4.3.1.3. Beispiele

Ein Beispiel wird ganz am Anfang des Handbuches gegeben.

Wenn nur Strings in den Cache gespeichert werden (denn mit der "automaticSerialization" Option wäre es möglich Booleans zu speichern), kann ein kompakterer Weg wie folgt gewählt werden:

    <?php

    // Es wird angenommen das $cache existiert

    $id = 'myBigLoop'; // Die Cache ID von dem "das gecached werden soll"

    if (!($data = $cache->load($id))) {
        // Cache miss

        $data = '';
        for ($i = 0; $i < 10000; $i++) {
            $data = $data . $i;
        }

        $cache->save($data);

    }

    // [...] Irgendwas mit $data machen (ausgeben, verarbeiten, usw.)

    ?>

Wenn mehrere Blöcke von Daten oder Daten Instanzen gecached werden sollen, ist die Idee dahinter die gleiche:

    <?php

    // Sicherstellen, dass eindeutige Identifizierer verwendet werden:
    $id1 = 'foo';
    $id2 = 'bar';

    // Block 1
    if (!($data = $cache->load($id1))) {
        // Cache miss

        $data = '';
        for ($i=0;$i<10000;$i++) {
            $data = $data . $i;
        }

        $cache->save($data);

    }
    echo($data);

    // Hier wird NIE gecached
    echo('NIE GECACHED! ');

    // Block 2
    if (!($data = $cache->load($id2))) {
        // Cache miss

        $data = '';
        for ($i=0;$i<10000;$i++) {
            $data = $data . '!';
        }

        $cache->save($data);

    }
    echo($data);

    ?>

### 4.3.2. Zend_Cache_Frontend_Output

#### 4.3.2.1. Einführung

`Zend_Cache_Frontend_Output` ist ein Ausgabe-Empfangendes Frontend. Es verwendet den Ausgabe Puffer in PHP, um alles zwischen der `start()` und der `end()` Methode zu fangen.

#### 4.3.2.2. Mögliche Optionen

Dieses Frontend hat keine bestimmten Optionen zusätzlich zu denen von `Zend_Cache_Core`.

#### 4.3.2.3. Beispiele

Ein Beispiel wird ganz am Anfang des Handbuches gegeben. Hier ist es mit kleinen Änderungen:

    <?php

    // Wenn es ein Cache Miss ist, wird das puffern der Ausgabe ausgelöst
    if(!$cache->start('mypage')):

    // Alle wie gewohnt ausgeben
    echo 'Hallo Welt! ';
    echo 'Das wird gecached ('.time().') ';

    $cache->end(); // Ausgabepufferung beenden
    endif;

    echo 'Hier wird nie gecached ('.time().').';

    ?>

Die Verwendung dieser Form ist ziemlich einfach, um Ausgabe caching in einem bereits bestehenden Projekt, mit nur wenig oder gar keinen Codeänderungen, zu erhalten.

### 4.3.3. Zend_Cache_Frontend_Function

#### 4.3.3.1. Einführung

`Zend_Cache_Frontend_Function` cached das Ergebnis von Funktionsaufrufen. Es hat eine einzelne Hauptmethode genannt `call()`, welche den Funktionsnamen und Parameter für den Aufruf in einem Array entgegennimmt.

#### 4.3.3.2. Mögliche Optionen

Tabelle 4.2. Mögliche Optionen

Option | Daten Typ | Standardwert | Beschreibung
--- | --- | --- | ---
`cacheByDefault` | `boolean` | `true` | Wenn true, wird der Funktionsaufruf standardmäßig gecached
`cachedFunctions` | `array` |  | Funktionsnamen, die immer gecached werden sollen
`nonCachedFunctions` | `array` |  | Funktionsnamen, die nie gecached werden sollen

#### 4.3.3.3. Beispiele

Die Verwendung der `call()` Funktion ist die gleiche, wie die von `call_user_func_array()` in PHP:

    <?php

    $cache->call('veryExpensiveFunc', $params);

    # $params ist ein Array
    # Zum Beispiel fürs Aufrufen (mit cachen) von veryExpensiveFunc(1, 'foo', 'bar'), wird
    # $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar')) benutzt

    ?>

`Zend_Cache_Frontend_Function` ist elegant genug, um beides zu cachen, den Rückgabewert der Funktion und deren interne Ausgabe.

| Anmerkung
Man kann jede eingebaute oder benutzerdefinierte Funktion übergeben, mit ausnahme von `array()`, `echo()`, `empty()`, `eval()`, `exit()`, `isset()`, `list()`, `print()` und `unset()`.

### 4.3.4. Zend_Cache_Frontend_Class

#### 4.3.4.1. Einführung

`Zend_Cache_Frontend_Class` ist unterschiedlich zu `Zend_Cache_Frontend_Function`, weil es das Cachen von Objekten und statischen Methodenaufrufen erlaubt.

#### 4.3.4.2. Mögliche Optionen

Tabelle 4.3. Mögliche Optionen

Option | Datentyp | Standardwert | Beschreibung
--- | --- | --- | ---
`cachedEntity` (Notwendig) | `mixed` |  | Wenn auf einen Klassennamen gesetzt, wird eine abstrakte Klasse gecached und es werden statische Aufrufe verwendet; wenn auf ein Objekt gesetzt, wird deren Objektmethoden gecached
`cacheByDefault` | `boolean` | `true` | Wenn true, wird der Aufruf standardmäßig gecached
`cachedMethods` | `array` |  | Methodennamen, die immer gecached werden sollen
`nonCachedMethods` | `array` |  | Methodennamen, die nie gecached werden sollen

#### 4.3.4.3. Beispiele

zum Beispiel, um einen statischen Aufruf zu cachen:

    <?php

    class test {

        # Statische Methode
        public static function foobar($param1, $param2) {
            echo "foobar_output($param1, $param2)";
            return "foobar_return($param1, $param2)";
        }

    }

    // [...]
    $frontendOptions = array(
        'cachedEntity' => 'test' // Der Name der Klasse
    );
    // [...]

    # Der gecachte Aufruf
    $res = $cache->foobar('1', '2');

    ?>

Um klassische Methodenaufrufe zu cachen :

    <?php

    class test {

        private $_string = 'Hallo !';

        public function foobar2($param1, $param2) {
            echo($this->_string);
            echo "foobar2_output($param1, $param2)";
            return "foobar2_return($param1, $param2)";
        }

    }

    // [...]
    $frontendOptions = array(
        'cachedEntity' => new test() // Eine Instanz der Klasse
    );
    // [...]

    # Der gecachte Aufruf
    $res = $cache->foobar2('1', '2');

    ?>

### 4.3.5. Zend_Cache_Frontend_File

#### 4.3.5.1. Einführung

`Zend_Cache_Frontend_File` ist ein Frontend angetrieben durch den Änderungszeitpunkt einer "Masterdatei". Es ist wirklich interessant für Beispiele in Konfigurations- oder Templateanwendungen.

Zum Beispiel eine XML Konfigurationsdatei, welche von einer Funktion geparsed wird und die ein "Config Objekt" zurückgibt (wie durch `Zend_Config`). Mit `Zend_Cache_Frontend_File` kann das "Config Objekt" im Cache gespeichert werden (um zu Verhindern, das die XML Konfiguration jedes mal geparsed wird), aber mit einer strengen Abhängigkeit zur "Masterdatei". Wenn also die XML Konfigurationsdatei geändert wird, wird der Cache sofort ungültig.

#### 4.3.5.2. Mögliche Optionen

Tabelle 4.4. Mögliche Optionen

Option | Daten Typ | Standardwert | Beschreibung
--- | --- | --- | ---
`masterFile (mandatory)` | `string` | `` | Der komplette Pfad und Name der Master Datei

#### 4.3.5.3. Beispiele

Die Verwendung dieses Frontends ist die gleiche wie die von `Zend_Cache_Core`. Es gibt kein eigenes Beispiel - was als einziges gemacht werden muß, ist das `masterFile` zu definieren, wenn die Factory verwendet wird.

### 4.3.6. Zend_Cache_Frontend_Page

#### 4.3.6.1. Einführung

`Zend_Cache_Frontend_Page` ist wie `Zend_Cache_Frontend_Output` aber entwickelt für eine komplette Seite. Es ist unmöglich `Zend_Cache_Frontend_Page` nur für das Cachen eines einzelnen Blockes zu verwenden.

Andererseits wird die "Cache ID" automatisch berechnet mit `$_SERVER['REQUEST_URI']` und (abhängig von den Optionen) mit `$_GET`, `$_POST`, `$_SESSION`, `$_COOKIE`, `$_FILES`. Trotzdem muß nur eine Methode aufgerufen werden (`start()`), weil der Aufruf von `end()` immer vollautomatisch ist, wenn die Seite endet.

Zur Zeit ist es nicht eingebaut, aber es ist ein HTTP abhängiges System geplant, um Bandbreiten zu sparen (das System wird ein "HTTP 304 nicht geändert" schicken, wenn der Cache gefunden wurde und wenn der Browser bereits eine gültige Version hat).

| Anmerkung
Zend_Cache_Frontend_Page ist wirklich eine "Alpha Version" und ist zukünftig für Verbesserungen vorgesehen.

#### 4.3.6.2. Mögliche Optionen (Für dieses Frontend in der Zend_Cache Factory)

Tabelle 4.5. Mögliche Optionen

Option | Daten Typ | Standardwert | Beschreibung
--- | --- | --- | ---
`httpConditional` | `boolean` | `false` | Verwendung des httpConditional Systems (zur Zeit nicht implementiert)
`debugHeader` | `boolean` | `false` | Wenn true, wird eine Debugging Text for jeder gecacheten Seite hinzugefügt
`defaultOptions` | `array` | `array(...siehe unten...)` | Ein assoziatives Array mit Default Optionen: `(boolean, true per Default) cache` : Cache ist aktiviert wenn true `(boolean, false per Default) cacheWithGetVariables` : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im `$_GET` Array gibt `(boolean, false per Default) cacheWithPostVariables` : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im `$_POST` Array gibt `(boolean, false per Default) cacheWithSessionVariables` : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im `$_SESSION` Array gibt `(boolean, false per Default) cacheWithFilesVariables` : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im `$_FILES` Array gibt `(boolean, false per Default) cacheWithCookieVariables` : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im `$_COOKIE` Array gibt `(boolean, true per Default) makeIdWithGetVariables` : wenn true, wird die Cache ID vom Inhalt des `$_GET` Arrays abhängig sein `(boolean, true per Default) makeIdWithPostVariables` : wenn true, wird die Cache ID vom Inhalt des `$_POST` Arrays abhängig sein `(boolean, true per Default) makeIdWithSessionVariables` : wenn true, wird die Cache ID vom Inhalt des `$_SESSION` Arrays abhängig sein `(boolean, true per Default) makeIdWithFilesVariables` : wenn true, wird die Cache ID vom Inhalt des `$_FILES` Arrays abhängig sein `(boolean, true per Default) makeIdWithCookieVariables` : wenn true, wird die Cache ID vom Inhalt des `$_COOKIE` Arrays abhängig sein
`regexps` | `array` | `array()` | Ein assoziatives Array, um Optionen nur für einige REQUEST_URI zu setzen. Die Schlüssel sind reguläre Ausdrücke (PCRE), die Werte sind ein assoziatives Array mit spezifischen Optionen, die gesetzt werden sollen, wenn der reguläre Ausdruck auf $_SERVER['REQUEST_URI'] passt (siehe die defaultOptions für eine Liste der verfügbaren Optionen); wenn verschiedene reguläre Ausdrücke auf $_SERVER['REQUEST_URI'] passen, wird nur der letzte verwendet.

#### 4.3.6.3. Beispiele

Die Verwendung von Zend_Cache_Frontend_Page ist wirklich trivial :

    <?php

    // [...] // Benötigt, Konfiguration und Factory

    $cache->start();
    // Wenn der Cache gefunden wurde, wird das Ergebnis zum Browser geschickt, und das Skript stoppt hier

    // Rest der Seite ...

    ?>

Ein etwas komplexeres Beispiel, welches einen Weg zeigt, um ein zentralisiertes Cache Management in einer Bootstrap Datei zu erhalten (um es z.B. mit Zend_Controller´ zu verwenden)

    <?php

    // [...] du solltest es vermeiden, zu viele Zeilen vor dem Cache Bereich zu setzen
    // [...] zum Beispiel sollten für optimale Performanz "require_once" oder "Zend::loadClass"
    // [...] nach dem Cache Bereich stehen

    require_once 'Zend/Cache.php';

    $frontendOptions = array(
       'lifeTime' => 7200,
       'debugHeader' => true, // für das Debugging
       'regexps' => array(
           '^/$' => array('cache' => true),         // cache den gesamten IndexController
           '^/index/' => array('cache' => true),    // cache den gesamten IndexController
           '^/article/' => array('cache' => false), // wir cachen nicht den ArticleController...
           '^/article/view/' => array(              // ...aber wir cachen die "View" Aktion von
               'cache' => true,                     // diesem ArticleController
               'cacheWithPostVariables' => true,    // und wir cachen sogar wenn es einige Variablen in $_POST gibt
               'makeIdWithPostVariables' => true,   // (aber die Cache Id wird vom $_POST Array abhängig sein)
           )
       )
    );
    $backendOptions = array(
        'cacheDir' => '/tmp/'
    );

    // erhalte ein Zend_Cache_Frontend_Page Objekt
    $cache = Zend_Cache::factory('Page', 'File', $frontendOptions, $backendOptions);

    $cache->start();

    // Wenn der Cache gefunden wurde, wird das Ergebnis zum Browser geschickt, und das Skript stoppt hier

    // [...] das Ende der Bootstrap Datei (diese Zeilen werden nicht ausgeführt, wenn der Cache ausgegeben wurde)

    ?>

Zurück | Nach oben | Weiter
4.2. Die Theorie des Cachens | Zum Anfang | 4.4. Zend_Cache Backends