Zend_Captcha-Adapters.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15207 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.captcha.adapters">
  5. <title>CAPTCHA Adapter</title>
  6. <para>
  7. Die folgenden Adapter werden mit dem Zend Framework standardmäßig ausgeliefert.
  8. </para>
  9. <sect2 id="zend.captcha.adapters.word">
  10. <title>Zend_Captcha_Word</title>
  11. <para>
  12. <classname>Zend_Captcha_Word</classname> ist ein abstrakter Adapter der als Basisklasse für die
  13. meisten anderen CAPTCHA Adapter fungiert. Er bietet Mutatoren für die Spezifizierung der
  14. Wortlänge, Session TTL, das Session Namespaceobjekt das verwendet werden soll, und die
  15. Session Namespaceklasse die für die Persistenz zu verwenden ist wenn man
  16. <classname>Zend_Session_Namespace</classname> nicht verwenden will. <classname>Zend_Captcha_Word</classname>
  17. kapselt die Prüflogik.
  18. </para>
  19. <para>
  20. Standardmäßig ist die Wortlänge 8 Zeichen, das Sessiontimeout 5 Minuten und für die
  21. Persistenz wird <classname>Zend_Session_Namespace</classname> verwendet (wobei der Namespace
  22. "Zend_Form_Captcha_&lt;captcha ID&gt;" verwendet wird).
  23. </para>
  24. <para>
  25. Zusätzlich zu den Methoden wie vom <classname>Zend_Captcha_Adapter</classname> Interface benötigt
  26. werden bietet <classname>Zend_Captcha_Word</classname> die folgenden Methoden an:
  27. </para>
  28. <itemizedlist>
  29. <listitem><para>
  30. <code>setWordLen($length)</code> und <code>getWordLen()</code> erlauben es die Länge des
  31. erzeugten "Wortes" in Zeichen zu spezifizieren, und den aktuellen Wert zu erhalten.
  32. </para></listitem>
  33. <listitem><para>
  34. <code>setTimeout($ttl)</code> und <code>getTimeout()</code> erlauben es die Lebenszeit des
  35. Sessiontokens zu spezifizieren, und den aktuellen Wert er erhalten. <code>$ttl</code> sollte
  36. in Sekunden spezifiziert sein.
  37. </para></listitem>
  38. <listitem><para>
  39. <code>setSessionClass($class)</code> und <code>getSessionClass()</code> erlauben es eine
  40. alternative <classname>Zend_Session_Namespace</classname> Implementation zu spezifizieren die
  41. verwendet werden soll um das CAPTCHA Token persistent zu machen und den aktuellen Wert
  42. zu bekommen.
  43. </para></listitem>
  44. <listitem><para>
  45. <code>getId()</code> erlaubt es den aktuellen Tokenidentifikator zu erhalten.
  46. </para></listitem>
  47. <listitem><para>
  48. <code>getWord()</code> erlaubt es das erzeugte Wort das mit dem CAPTCHA verwendet wird
  49. zu erhalten. Es wird das Wort erzeugen wenn es bis dahin noch nicht erstellt wurde.
  50. </para></listitem>
  51. <listitem><para>
  52. <code>setSession(Zend_Session_Namespace $session)</code> erlaubt es ein Sessionobjekt zu
  53. spezifizieren das für die Persistenz des CAPTCHA Tokens verwendet wird. <code>getSession()</code>
  54. erlaubt es das aktuelle Sessionobjekt zu erhalten.
  55. </para></listitem>
  56. </itemizedlist>
  57. <para>
  58. Alle Wort CAPTCHAs erlauben es ein Array von Optionen an den Konstruktor zu übergeben, oder
  59. alternativ dieses an <code>setOptions()</code> zu übergeben. Man kan auch ein <classname>Zend_Config</classname>
  60. Objekt an <code>setConfig()</code> zu übergeben. Standardmäßig können die <code>wordLen</code>,
  61. <code>timeout</code>, und <code>sessionClass</code> Schlüssel alle verwendet werden. Jede
  62. konkrete Implementation kann zusätzliche Schlüssel definieren oder die Optionen auf einem
  63. anderen Weg verwenden.
  64. </para>
  65. <note>
  66. <para>
  67. <classname>Zend_Captcha_Word</classname> ist eine abstrakte Klasse und kann nicht direkt
  68. instanziiert werden.
  69. </para>
  70. </note>
  71. </sect2>
  72. <sect2 id="zend.captcha.adapters.dumb">
  73. <title>Zend_Captcha_Dumb</title>
  74. <para>
  75. Der <classname>Zend_Captcha_Dumb</classname> Adapter ist fast selbsterklärend. Er bietet einen
  76. zufälligen String der in umgekehrter Reihenfolge eingegeben werden muß um validiert
  77. zu werden. Als solches ist es keine gute CAPTCHA Lösung, und sollte nur für Testzwecke
  78. verwendet werden. Er erweitert <classname>Zend_Captcha_Word</classname>.
  79. </para>
  80. </sect2>
  81. <sect2 id="zend.captcha.adapters.figlet">
  82. <title>Zend_Captcha_Figlet</title>
  83. <para>
  84. Der <classname>Zend_Captcha_Figlet</classname> Adapter verwendet
  85. <link linkend="zend.text.figlet"><classname>Zend_Text_Figlet</classname></link> um dem
  86. Benutzer ein Figlet zu präsentieren.
  87. </para>
  88. <para>
  89. Optionen die an den Konstruktor übergeben werden, werden auch an das
  90. <link linkend="zend.text.figlet">Zend_Text_Figlet</link> Objekt übergeben. Schaue in die
  91. <link linkend="zend.text.figlet">Zend_Text_Figlet</link> Dokumentation für Details darüber
  92. welche Konfigurationsoptionen vorhanden sind.
  93. </para>
  94. </sect2>
  95. <sect2 id="zend.captcha.adapters.image">
  96. <title>Zend_Captcha_Image</title>
  97. <para>
  98. Der Zend_Captcha_Image Adapter nimmt das erzeugte Wort und stellt es als Bild dar, führt
  99. diverse Verzerrungs-Permutationen durch und mach es so schwierig es automatisch zu
  100. entschlüsseln. Er benötigt die <ulink url="http://php.net/gd">GD Erweiterung</ulink>
  101. kompiliert mit TrueType oder Freetype Unterstützung. Aktuell kann der Zend_Captcha_Image
  102. Adapter nur PNG Bilder erzeugen.
  103. </para>
  104. <para>
  105. <classname>Zend_Captcha_Image</classname> erweitert <classname>Zend_Captcha_Word</classname>, und bietet zusätzlich
  106. die folgenden Methoden:
  107. </para>
  108. <itemizedlist>
  109. <listitem><para>
  110. <code>setExpiration($expiration)</code> und <code>getExpiration()</code> erlauben es eine
  111. maximale Lebenszeit zu definieren die das CAPTCHA Bild auf dem Dateisystem bleibt. Das ist
  112. typischerweise längerer als die Session Lifetime. Die Garbage Collection läuft periodisch
  113. jedes Mal wenn das CAPTCHA Objekt enthalten ist, und löscht die Bilder die abgelaufen sind.
  114. Der Wert der Löschung sollte in Sekunden angegeben werden.
  115. </para></listitem>
  116. <listitem><para>
  117. <code>setGcFreq($gcFreq)</code> und <code>getGcFreg()</code> erlauben es zu spezifizieren wie
  118. oft die Garbage Collection laufen soll. Die Garbage Collection wird alle
  119. <code>1/$gcFreq</code> Aufrufe ausgeführt. Standard ist 100.
  120. </para></listitem>
  121. <listitem><para>
  122. <code>setFont($font)</code> und <code>getFont()</code> erlauben es die Schrift zu spezifizieren
  123. die man verwenden will. <code>$font</code> sollte ein voll qualifizierter Pfad zu der
  124. Schriftart-Datei sein. Dieser Wert wird benötigt; das CAPTCHA wird wärend der Erzeugung
  125. eine Ausnahme werfen wenn die Schriftdatei nicht spezifiziert wurde.
  126. </para></listitem>
  127. <listitem><para>
  128. <code>setFontSize($fsize)</code> und <code>getFontSize()</code> erlauben es die Schriftgröße
  129. in Pixel zu spezifizieren die verwendet wird wenn das CAPTCHA erzeugt wird. Der
  130. Standardwert ist 24px.
  131. </para></listitem>
  132. <listitem><para>
  133. <code>setHeight($height)</code> und <code>getHeight()</code> erlauben es die Höhe in Pixel zu
  134. spezifizieren die das erzeugte CAPTCHA Bild haben soll. Der Standardwert ist 50px.
  135. </para></listitem>
  136. <listitem><para>
  137. <code>setWidth($width)</code> und <code>getWidth()</code> erlauben es die Breite in Pixel
  138. zu spezifizieren die das erzeugte Captcha Bild haben soll. Der Standardwert ist 200px.
  139. </para></listitem>
  140. <listitem><para>
  141. <code>setImgDir($imgDir)</code> und <code>getImgDir()</code> erlauben es das Verzeichnis für
  142. das Speicher der CAPTCHA Bilder zu spezifizieren. Der Standardwert ist
  143. "./images/captcha/", was relativ zum Bootstrapskript zu sehen ist.
  144. </para></listitem>
  145. <listitem><para>
  146. <code>setImgUrl($imgUrl)</code> und <code>getImgUrl()</code> erlauben es den Relativen Pfad
  147. zum CAPTCHA Bild für die Verwendung im HTML Markup zu spezifizieren. Der Standardwert ist
  148. "/images/captcha/".
  149. </para></listitem>
  150. <listitem><para>
  151. <code>setSuffix($suffix)</code> und <code>getSuffix()</code> erlauben es die Endung des
  152. Dateinamens für das CAPTCHA Bild zu spezifizieren. Der Standardwert ist ".png".
  153. Beachte: Das Ändern dieses Wertes wird den Typ des erzeugten Bildes nicht ändern.
  154. </para></listitem>
  155. </itemizedlist>
  156. <para>
  157. Alle der obigen Optionen können an den Konstruktor übergeben werden indem einfach
  158. der Präfix der 'set' Methode entfernt wird und der Anfangsbuchstabe kleingeschrieben wird:
  159. "suffix", "height", "imgUrl", usw.
  160. </para>
  161. </sect2>
  162. <sect2 id="zend.captcha.adapters.recaptcha">
  163. <title>Zend_Captcha_ReCaptcha</title>
  164. <para>
  165. Der <classname>Zend_Captcha_ReCaptcha</classname> Adapter verwendet
  166. <link linkend="zend.service.recaptcha">Zend_Service_ReCaptcha</link> um CAPTCHAs zu erzeugen
  167. und zu prüfen. Es bietet die folgenden Methoden an:
  168. </para>
  169. <itemizedlist>
  170. <listitem><para>
  171. <code>setPrivKey($key)</code> und <code>getPrivKey()</code> erlauben es den privaten Schlüssel
  172. zu spezifizieren der für den ReCaptcha Service verwendet werden soll. Er muß wärend der
  173. Erstellung spezifiziert werden, auch wenn er jederzeit überschrieben werden kann.
  174. </para></listitem>
  175. <listitem><para>
  176. <code>setPubKey($key)</code> und <code>getPubKey()</code> erlauben es den öffentlichen
  177. Schlüssel zu spezifizieren der mit dem ReCaptcha Service verwendet werden soll. Er muß wärend
  178. der Erstellung spezifiziert werden, auch wenn er jederzeit überschrieben werden kann.
  179. </para></listitem>
  180. <listitem><para>
  181. <code>setService(Zend_Service_ReCaptcha $service)</code> und <code>getService()</code>
  182. erlauben es das ReCaptcha Serviceobjekt zu setzen und erhalten.
  183. </para></listitem>
  184. </itemizedlist>
  185. </sect2>
  186. </sect1>
  187. <!--
  188. vim:se ts=4 sw=4 et:
  189. -->