1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.captcha.operation">
<title>Captcha Operation</title>
<para>
All <acronym>CAPTCHA</acronym> adapter implement
<classname>Zend_Captcha_Adapter</classname>, which looks like the following:
</para>
<programlisting language="php"><![CDATA[
interface Zend_Captcha_Adapter extends Zend_Validate_Interface
{
public function generate();
public function render(Zend_View $view, $element = null);
public function setName($name);
public function getName();
public function getDecorator();
// Additionally, to satisfy Zend_Validate_Interface:
public function isValid($value);
public function getMessages();
public function getErrors();
}
]]></programlisting>
<para>
The name setter and getter are used to specify and retrieve the
<acronym>CAPTCHA</acronym> identifier. <methodname>getDecorator()</methodname> can be used
to specify a <classname>Zend_Form</classname> decorator either by name or returning an
actual decorator object. The most interesting methods are
<methodname>generate()</methodname> and <methodname>render()</methodname>.
<methodname>generate()</methodname> is used to create the <acronym>CAPTCHA</acronym>
token. This process typically will store the token in the session so that you may compare
against it in subsequent requests. <methodname>render()</methodname> is used to render the
information that represents the <acronym>CAPTCHA</acronym>, be it an image, a figlet, a
logic problem, or some other <acronym>CAPTCHA</acronym>.
</para>
<para>
A typical use case might look like the following:
</para>
<programlisting language="php"><![CDATA[
// Creating a Zend_View instance
$view = new Zend_View();
// Originating request:
$captcha = new Zend_Captcha_Figlet(array(
'name' => 'foo',
'wordLen' => 6,
'timeout' => 300,
));
$id = $captcha->generate();
echo "<form method=\"post\" action=\"\">";
echo $captcha->render($view);
echo "</form>";
// On subsequent request:
// Assume captcha setup as before, the value of $_POST['foo']
// would be key/value array: id => captcha ID, input => captcha value
if ($captcha->isValid($_POST['foo'], $_POST)) {
// Validated!
}
]]></programlisting>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->
|
