Zend Framework 1.7.9 Manual

Zend_Captcha_Word ist ein abstrakter Adapter der als Basis für die Dumb, Figlet, und Image Adapter fungiert. Er bietet Mutatoren für die Spezifizierung der Wortlänge, Session TTL, das Session Namespaceobjekt das verwendet werden soll, und die Session Namespaceklasse die für die Persistenz zu verwenden ist wenn man Zend_Session_Namespace nicht verwenden will. Zusätzlich kapselt er die komplette Prüflogik.

Standardmäßig ist die Wortlänge 8 Zeichen, das Sessiontimeout 5 Minuten und für die Persistenz wird Zend_Session_Namespace verwendet (wobei der Namespace "Zend_Form_Captcha_<captcha ID>" verwendet wird).

Zusätzlich zu den Standardmethoden wie vom Zend_Captcha_Adapter Interface benötigt werden bietet Zend_Captcha_Word die folgenden Methoden an:

• setWordLen($length) und getWordLen() erlauben es die Länge des erzeugten "Wortes" in Zeichen zu spezifizieren, und den aktuellen Wert zu erhalten.

• setTimeout($ttl) und getTimeout() erlauben es die Lebenszeit des Sessiontokens zu spezifizieren, und den aktuellen Wert er erhalten. $ttl sollte in Sekunden spezifiziert sein.

• setSessionClass($class) und getSessionClass() erlauben es eine alternative Zend_Session_Namespace Implementation zu spezifizieren die verwendet werden soll um das Captchatoken persistent zu machen, sowie den aktuellen Wert zu erhalten.

• getId() erlaubt es den aktuellen Tokenidentifikator zu erhalten.

• getWord() erlaubt es das erzeugte Wort das mit dem Captcha verwendet wird zu erhalten; es wird erzeugt wen es bis dahin noch nicht erheugt wurde.

• setSession(Zend_Session_Namespace $session) erlaubt es ein Sessionobjekt zu spezifizieren das für die Persistenz des Captchatokens verwendet wird; getSession() erlaubt es das aktuelle Sessionobjekt zu erhalten.

Alle Word Captchas erlauben es ein Array von Optionen an den Konstruktor zu übergeben, oder alternativ dieses an setOptions() zu übergeben (oder ein Zend_Config Objekt an setConfig() zu übergeben). Standardmäßig können die wordLen, timeout, und sessionClass Schlüssel alle verwendet werden; jede konkrete Implementation kann zusätzliche Schlüssel definieren oder die Optionen auf einem anderen Weg verwenden.

Note:

Word ist eine abstrakte Klasse und kann nicht direkt instanziiert werden.

Der Dumb Adapter ist fast selbst-erklärend. Er bietet einen zufälligen String der in umgekehrter Reihenfolge eingegeben werden muß um validiert zu werden. Als solches ist es keine gute CAPTCHA Lösung, und sollte nur für Testzwecke oder als letzter Ausweg verwendet werden. Er erweitert Zend_Captcha_Word.

Der Figlet Adapter verwendet Zend_Text_Figlet um dem Benutzer ein Figlet zu präsentieren. Figlet Captchas sind nur auf Zeichen limitiert.

Optionen die an den Konstruktor übergeben werden, werden auch an das Zend_Text_Figlet Objekt übergeben das der Adapter verwendet; für Details darüber welche Konfigurationsoptionen verwendet werden können siehe in die Dokumentation.

Der Image Adapter nimmt das erzeugte Wort und stellt es als Bild dar, führt diverse Verzerrungs- Permutationen auf Ihm durch und mach es so schwierig es automatisch zu entschlüsseln. Um diese Arbeit durchzuführen, benötigt es die » GD extension Erweiterung kompiliert mit TrueType oder Freetype Unterstützung. Aktuell kann der Image Adapter nur PNG Bilder erzeugen.

Zend_Captcha_Image erweitert Zend_Captcha_Word, und bietet zusätzlich die folgenden Methoden:

• setExpiration($expiration) und getExpiration() erlauben es eine maximale Lebenszeit zu definieren die ein Bild auf dem Dateisystem bleibt. Das ist typischerweise ein längerer Zeitraum als die Sessionlifetime. Die Garbage Collection läuft periodisch jedes Mal wenn das Captcha Objekt enthalten ist, und Bilder die abgelaufen sind werden gelöscht. Der Wert der Löschung ist in Sekunden anzugeben.

• setGcFreq($gcFreq) und getGcFreg() erlauben es zu spezifizieren wie oft die Garbage Collection laufen soll. Die Garbage Collection wird alle 1/$gcFreq Aufrufe ausgeführt (Standard ist 100).

• setFont($font) und getFont() erlauben es die Schrift zu spezifizieren die verwendet werden soll. $font sollte ein voll qualifizierter Pfad zu der Schriftart-Datei sein die verwendet werden soll. Wenn dieser Wert nicht gesetzt wird, wird Captcha wärend der Erzeugung eine Ausnahme werden; die Schrift ist zwingend notwendig.

• setFontSize($fsize) und getFontSize() erlauben es die Schriftgröße, in Pixel, zu spezifizieren die verwendet wird wenn das Captcha erzeugt wird. Der Standardwert ist 24px.

• setHeight($height) und getHeight() erlauben es die Höhe, in Pixel, zu spezifizieren die das erzeugte Captchabild haben soll. Der Standardwert ist 50px.

• setWidth($width) und getWidth() erlauben es die Breite, in Pixel, zu spezifizieren die das erzeugte Captchabild haben soll. Der Standardwert ist 200px.

• setImgDir($imgDir) und getImgDir() erlauben es das Verzeichnis zu spezifizieren in dem das Captchabilder gespeichert werden. Der Standardwert ist "./images/captcha/", was relativ zum Bootstrapskript zu sehen ist.

• setImgUrl($imgUrl) und getImgUrl() erlauben es den Relativen Pfad zum Captchabild für die Verwendung im HTML Markup zu spezifizieren. Der Standardwert ist "/images/captcha/".

• setSuffix($suffix) und getSuffix() erlauben es die Endung des Dateinamens zu spezifizieren der verwendet werden soll. Der Standardwert ist ".png". Beachte: Das Ändern dieses Werte wird den Typ des erzeugten Bildes nicht ändern.

Alle der obigen Optionen können als Option an den Konstruktor übergeben werden indem einfach der Präfix der 'set' Methode entfernt wird und der Anfangsbuchstabe kleingeschrieben wird: "suffix", "height", "imgUrl", usw.

Der ReCaptcha Adapter verwendet Zend_Service_ReCaptcha um Captchas zu erzeugen und zu prüfen. Es bietet die folgenden Methoden an:

• setPrivKey($key) und getPrivKey() erlauben es den privaten Schlüssel zu spezifizieren der mit dem ReCaptcha Service verwendet werden soll. Er muß wärend der Erstellung spezifiziert werden, auch wenn er jederzeit überschrieben werden kann.

• setPubKey($key) und getPubKey() erlauben es den öffentlichen Schlüssel zu spezifizieren der mit dem ReCaptcha Service verwendet werden soll. Er muß wärend der Erstellung spezifiziert werden, auch wenn er jederzeit überschrieben werden kann.

• setService(Zend_Service_ReCaptcha $service) und getService() erlauben es das ReCaptcha Serviceobjekt zu spezifizieren und mit Ihm zu interagieren.