Zend_Captcha-Adapters.xml 11 KB

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