Cache deine Templates / Dateien

• Schneller Einstieg

  • Was ist webpackages ?
  • Installation
  • Hello World

• Grundlagen

  • Modul View Controller (MVC)
  • load_functions Klasse
  • Hilfsklassen

• Hilfsklassen

  • Benchmark Klasse
  • Cache Klasse
  • Captcha Klasse
  • cURL Klasse
  • Database Klasse
  • Date Klasse
  • Errors Klasse
  • FileSystem Klasse
  • FTP Klasse
  • Images Klasse
  • Language Klasse
  • Logger Klasse
  • Number Klasse
  • PayPal Klasse
  • PHPMailer Klasse
  • Plugins Klasse
  • RestClient Klasse
  • Security Klasse
  • Template Klasse
  • Text Klasse
  • URL Klasse
  • XML Klasse
  • ZIP Klasse

Cache Klasse

In den folgenden Abschnitten werden die einzelnen Methoden der Klasse erklärt.

set_cache_dir

public static boolean set_cache_dir ( String $cachePath)

Mit der set_cache_dir Methode legen Sie den Speicherort der Cache Dateien fest.

Parameterliste

cachePath

Der Pfad sollte ein absoluter zum Zielordner sein und komplikationen beim Verständnis zu vermeiden. Wenn der Ordner nicht existiert wird er angelegt. Sollte der Pfad leer sein oder der angegebene Pfad verweist nicht auf einen Ordner, wird ein false zurück gegeben

set_cache_active

public static boolean set_cache_active ( Boolean $active = false)

Setzt den Cache auf aktiv. Wenn der Cache inaktiv ist, werden keinerlei Daten in den Cache abgespeichert oder ausgelesen.

Parameterliste

active

Setzt den Cache auf aktiv true oder inaktiv false

set_cache_extension

public static boolean set_cache_extension ( String $extension = 'cache')

Jede Cache Datei bekommt die Dateiendung .cache. Wenn man diese abändern möchte, kann man hier eine alternative Dateiendung eintragen.

Parameterliste

extension

Die alternative Dateiendung für die Cache Dateien. Standardmäßig ".cache"

set_template_element

public static boolean set_template_element ( String $cache_name, String $content)

Die Methode set_template_element speichert ganze HTML Dateien in das Cache Verzeichnis ab. Somit können Webseiten schneller aufgebaut werden. PHP und MySQL ist dabei bereits geparst.

Achtung: Hierbei wird die Dateiendung .html verwendet und nicht die eingetragene Dateiendung von der Methode set_cache_extension

Parameterliste

cache_name

Der Parameter cache_name ist der eindeutige Name der Cache Datei. Dieser wird zum abspeichern auf dem Webserver verwendet. Hierbei sollten Sonderzeichen vermieden werden.

content

Der Parameter content ist der Inhalt der Cache Datei. Diese Methode sollte man nur verwenden, wenn man ganze HTML Abschnitte abspeichern möchte.

get_template_element

public static boolean|string get_template_element ( String $cache_name, Integer $lifetime = 500)

Gibt den Inhalt einer Template Cache Datei zurück, wenn die Lebensdauer nicht die Angabe des Parameters lifetime überschreiten. Ansonsten gibt die Methode false zurück.

Parameterliste

cache_name

Der Name der abzurufenden Cache Datei. Wenn die Methode keine Cache Datei unter diesen Namen findet, gibt die false zurück.

lifetime

Der Parameter lifetime ist dafür gedacht um nur Cache Inhalte zurückzugeben die einen bestimmten Alter entsprechen. Standardmäßig ist der Wert auf 500 Sekunden eingestellt.

set_element

public static boolean set_element ( String $cache_name, String $content, Integer $lifetime = 500)

Speichert einen Inhalt in eine Cache Datei ab. Diese Cache Datei existiert nur für den angegebenen Zeitraum. Ist der Zeitraum abgelaufen, wird die Cache Datei vom Webserver gelöscht. Bei Erfolg gibt diese Methode ein true zurück, andernfalls ein false.

Parameterliste

cache_name

Der Name der abzuspeichernden Cache Datei. Existiert bereits eine Cache Datei mit diesem Namen, wird sie überschrieben.

content

Der Inhalt der Cache Datei. Es werden hierbei alle gängigen PHP-Typen unterstützt.

lifetime

Die maximale Lebensdauer in Sekunden der Cache Datei.

get_element

public static boolean|mixed get_element ( String $cache_name)

Gibt den Inhalt der aufzurufenden Cache Datei zurück, solange die maximale Lebensdauer nicht überschritten ist. Andernfalls wird ein false zurück gegeben

Parameterliste

cache_name

Der Name der abzurufenden Cache Datei. Sollte die Cache Datei nicht existieren, wird ein false zurück gegeben.

delete_element

public static boolean delete_element ( String $cache_name)

Löscht eine Cache Datei im Cache Verzeichnis unwiderruflich und gibt bei Erfolg ein true, im Fehlerfall ein false zurück.

Parameterliste

cache_name

Der Dateiname der zu löschenden Cache Datei. Sollte die Datei nicht existiert, wird ein false zurück gegeben.