Zend_Cache_Core ist ein spezielles Frontend, da es der Kern dieses Moduls ist. Es ist ein generelles Cache Frontend und wurde von anderen Klassen erweitert. 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. Diese Optionen werden der Factory Methode übergeben wie im nachfolgenden Beispiel demonstriert. Option Daten Typ Standardwert Beschreibung caching boolean true Ein- / Ausschalten vom Caching (kann sehr nützlich für das Debuggen von gecachten Skripten sein) cache_id_prefix string null Ein Präfix für alle Cache IDs. Wenn er auf null gesetzt wird, wird kein Cache ID Präfix verwendet. Der Cache ID Präfix erstellt grundsätzlich einen Namespace im Cache, der verschiedenen Anwendungen oder Websites die Verwendung eines gemeinsamen Caches erlaubt. Jede Anwendung oder Website kann einen anderen Cache ID Prüfix verwenden sodas spezielle Cache IDs mehr als einmal verwendet werden können. 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) write_control boolean true Ein- / Ausschalten der Schreibkontrolle (der Cache 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) automatic_serialization 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) automatic_cleaning_factor 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. ignore_user_abort boolean false Auf true gesetzt, wird der Kern das PHP Flag ignore_user_abort innerhalb der save() Methode setzen um Cache Korruption in einigen fällen zuverhindern Ein Beispiel wird ganz am Anfang des Handbuches gegeben. Wenn nur Strings in den Cache gespeichert werden (denn mit der "automatic_serialization" Option wäre es möglich Booleans zu speichern), kann ein kompakterer Weg wie folgt gewählt werden: 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: 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); ]]> Wenn spezielle Werte gecached werden sollen (boolean mit der "automatic_serialization" Option) oder leere Strings kann die kompakte Erstellung wie oben gezeigt nicht verwendet werden. Der Cache Eintrag muß formell getestet werden. load($id))) { // Cache fehlgeschlagen // [...] wir erstellen $data $cache->save($data); } // wir machen etwas mit $data // [...] // die komplette Erstellung (funktioniert in jedem Fall) if (!($cache->test($id))) { // Cache fehlgeschlagen // [...] wir erstellen $data $cache->save($data); } else { // Cache getroffen $data = $cache->load($id); } // Wir machen irgendetwas mit $data ]]> 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. Dieses Frontend hat keine bestimmten Optionen zusätzlich zu denen von Zend_Cache_Core. Ein Beispiel wird ganz am Anfang des Handbuches gegeben. Hier ist es mit kleinen Änderungen: start('mypage'))) { // Alle wie gewohnt ausgeben echo 'Hallo Welt! '; echo 'Das wird gecached ('.time().') '; $cache->end(); // Ausgabepufferung beenden } 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. 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. Option Daten Typ Standardwert Beschreibung cache_by_default boolean true Wenn true, wird der Funktionsaufruf standardmäßig gecached cached_functions array Funktionsnamen, die immer gecached werden sollen non_cached_functions array Funktionsnamen, die nie gecached werden sollen Die Verwendung der call() Funktion ist die gleiche, wie die von call_user_func_array() in PHP: call('veryExpensiveFunc', $params); // $params ist ein Array // Für das Aufrufen von veryExpensiveFunc(1, 'foo', 'bar') mit Caching kann, // z.B. $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar')) benutzt // werden ]]> Zend_Cache_Frontend_Function ist elegant genug, um beides zu cachen, den Rückgabewert der Funktion und deren interne Ausgabe. Man kann jede eingebaute oder benutzerdefinierte Funktion übergeben, mit ausnahme von array(), echo(), empty(), eval(), exit(), isset(), list(), print() und unset(). Zend_Cache_Frontend_Class ist unterschiedlich zu Zend_Cache_Frontend_Function, weil es das Cachen von Objekten und statischen Methodenaufrufen erlaubt. Option Datentyp Standardwert Beschreibung cached_entity (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 cache_by_default boolean true Wenn true, wird der Aufruf standardmäßig gecached cached_methods array Methodennamen, die immer gecached werden sollen non_cached_methods array Methodennamen, die nie gecached werden sollen zum Beispiel, um einen statischen Aufruf zu cachen: 'Test' // Der Name der Klasse ); // [...] // Der gecachte Aufruf $result = $cache->foobar('1', '2'); ]]> Um klassische Methodenaufrufe zu cachen : _string); echo "foobar2_output($param1, $param2)"; return "foobar2_return($param1, $param2)"; } } // [...] $frontendOptions = array( 'cached_entity' => new Test() // Eine Instanz der Klasse ); // [...] // Der gecachte Aufruf $res = $cache->foobar2('1', '2'); ]]> Zend_Cache_Frontend_File ist ein Frontend angetrieben durch den Änderungszeitpunkt einer "Masterdatei". Es ist wirklich interessant für Beispiele in Konfigurations- oder Templateanwendungen. Es ist auch möglich mehrere Masterdateien zu verwenden. 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. Option Daten Typ Standardwert Beschreibung master_File (depreciated) string Der komplette Pfad und Name der Master Datei master_files array Ein Array der kompletten Pfade der Masterdateien master_files_mode string Zend_Cache_Frontend_File::MODE_OR Zend_Cache_Frontend_File::MODE_AND oder Zend_Cache_Frontend_File::MODE_OR ; bei MODE_AND müssen alle Masterdateien angegriffen werden um einen Cache ungültig zu machen, bei MODE_OR ist eine eizelne angegriffene Datei genug um den Cache ungültig zu machen ignore_missing_master_files boolean false bei true werden fehlende Masterdateien leise ignoriert (andernfalls wird eine Exception geworfen) 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 master_File zu definieren, wenn die Factory verwendet wird. 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). Option Daten Typ Standardwert Beschreibung http_conditional boolean false Verwendung des http_conditional Systems (zur Zeit nicht implementiert) debug_header boolean false Wenn true, wird eine Debugging Text for jeder gecacheten Seite hinzugefügt default_options array array(...siehe unten...) Ein assoziatives Array mit Default Optionen: (boolean, true per Default) cache : Cache ist aktiviert wenn true (boolean, false per Default) cache_with_get_variables : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im $_GET Array gibt (boolean, false per Default) cache_with_post_variables : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im $_POST Array gibt (boolean, false per Default) cache_with_session_variables : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im $_SESSION Array gibt (boolean, false per Default) cache_with_files_variables : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im $_FILES Array gibt (boolean, false per Default) cache_with_cookie_variables : wenn true, ist der Cache weiterhin aktiviert, selbst wenn es einige Variables im $_COOKIE Array gibt (boolean, true per Default) make_id_with_get_variables : wenn true, wird die Cache ID vom Inhalt des $_GET Arrays abhängig sein (boolean, true per Default) make_id_with_post_variables : wenn true, wird die Cache ID vom Inhalt des $_POST Arrays abhängig sein (boolean, true per Default) make_id_with_session_variables : wenn true, wird die Cache ID vom Inhalt des $_SESSION Arrays abhängig sein (boolean, true per Default) make_id_with_files_variables : wenn true, wird die Cache ID vom Inhalt des $_FILES Arrays abhängig sein (boolean, true per Default) make_id_with_cookie_variables : wenn true, wird die Cache ID vom Inhalt des $_COOKIE Arrays abhängig sein (int, false by default) specific_lifetime : wenn nicht false, wird die angegebene Lifetime für das ausgewählte Regex verwendet (array, array() by default) tags : Tags für den Cache Eintrag (int, null by default) priority : Priorität (wenn das Backend das unterstützt) 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 default_options für eine Liste der verfügbaren Optionen); wenn verschiedene reguläre Ausdrücke auf $_SERVER['REQUEST_URI'] passen, wird nur der letzte verwendet. memorize_headers array array() Ein Array von Strings die zu einem HTTP Headernamen korrespondieren. Aufgelistete Header werden mit den Cache Daten gespeichert und wieder "abgespielt" wenn der Cache getroffen wird. Die Verwendung von Zend_Cache_Frontend_Page ist wirklich trivial : 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) 7200, 'debug_header' => true, // für das Debuggen 'regexps' => array( // cache den gesamten IndexController '^/$' => array('cache' => true), // cache den gesamten IndexController '^/index/' => array('cache' => true), // wir cachen nicht den ArticleController... '^/article/' => array('cache' => false), // ...aber wir cachen die "View" Aktion von diesem ArticleController '^/article/view/' => array( 'cache' => true, // und wir cachen sogar wenn es einige Variablen in $_POST gibt 'cache_with_post_variables' => true, // aber die Cache Id wird vom $_POST Array abhängig sein 'make_id_with_post_variables' => true, ) ) ); $backendOptions = array( 'cache_dir' => '/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 ]]> Aus Designgründen, kann es in einigen Fällen (zum Beispiel bei Verwendung von nicht HTTP/200 Return Codes), notwendig sein den aktuellen Cacheprozess zu unterbrechen. Deshalb zeigen wir für dieses spezielle Frontend die cancel() Methode. start(); // [...] if ($someTest) { $cache->cancel(); // [...] } // [...] ]]>