Zend_Service_ReCaptcha in the standard incubator
I imported the Zend_Service_ReCaptcha stuff to the Zend Framework standard incubator yesterday. You can access it from the subversion repository at http://framework.zend.com/svn/framework/standard/incubator/library/Zend/Service/.
The component also includes a class to use the mail hide feature over at recaptcha.net that allows you to render an email address as something like user…@foo.com and the reader has to solve a recaptcha to see the complete email address.
No documentation has been made yet but I will include some basic usage of the component in this post.
Display a ReCaptcha in a form
First you need to register at recaptcha.net to get a set of public/private keys for the domain you want to use the recaptcha on. If you develop something locally and you use localhost as hostname you will need to register localhost on the recaptcha site to get the keys. Once you have the keys you are good to go!
When displaying the captcha you will only need the public key. The private key will be used when you verify the user input to see if a user has solved the captcha or not.
<?php
/** @see Zend_Service_ReCaptcha */
require_once 'Zend/Service/ReCaptcha.php';
$publicKey = 'my public key from recaptcha.net';
$reCaptcha = new Zend_Service_ReCaptcha($publicKey);
?>
<html>
<head>
<title>ReCaptcha test</title>
</head>
<body>
<form action="" method="post">
<?= $reCaptcha ?>
<input type="submit" name="submit" value="Submit" />
</form>
</body>
</html>
Replace the public key with your own public key and you will see something that hopefully resembles this screenshot:
Verify the user input
Now that we have our recaptcha in place we need to verify the user input. To do that we have to expand the block of php code at the top of our example here a bit.
PS! The syntax highlight plugin manages to write !emptyempty in the code below, so you’ll need to fix that if you copy the code.
<?php
/** @see Zend_Service_ReCaptcha */
require_once 'Zend/Service/ReCaptcha.php';
$publicKey = 'my public key from recaptcha.net';
$reCaptcha = new Zend_Service_ReCaptcha($publicKey);
// See if the form has been posted and that the two fields from the
// recaptcha are not empty
if (isset($_POST['submit']) &&
!empty($_POST['recaptcha_challenge_field']) &&
!empty($_POST['recaptcha_response_field']) ) {
// Set the private key. We need this to verify user input
$privateKey = 'my private key';
$reCaptcha->setPrivateKey($privateKey);
// See if the input is valid
$response = $reCaptcha->verify($_POST['recaptcha_challenge_field'],
$_POST['recaptcha_response_field']);
if (!$response->isValid()) {
// Not valid. Add the error message from the recaptcha web service
// to the recaptcha object so it will be shown in the recaptcha
$reCaptcha->setParam('error', $response->getErrorCode());
} else {
// Success! The recaptcha has been solved
}
}
?>
<html>
<head>
<title>ReCaptcha test</title>
</head>
<body>
<form action="" method="post">
<?= $reCaptcha ?>
<input type="submit" name="submit" value="Submit" />
</form>
</body>
</html>
And thats it!
Hide email addresses with Zend_Service_ReCaptcha_MailHide
If you need to display an email address you can hide parts of it using the Zend_Service_ReCaptcha_MailHide component. You need a separate pair of public/private keys for this so head over to recaptcha.net and grab those keys.
Lets say we want to hide mynewemailaddress@domain.com. Do something like the following piece of code:
/** @see Zend_Service_ReCaptcha */
require_once 'Zend/Service/ReCaptcha/MailHide.php';
$publicKey = 'my public key';
$privateKey = 'my super duper private key';
$mailHide = new Zend_Service_ReCaptcha_MailHide($publicKey,
$privateKey,
'mynewemailaddress@domain.com');
print($mailHide);
The output of this will be myne…@domain.com except that the “…” part will have link to a JavaScript popup that displays a recaptcha, and once the user solves it, the complete email address will be displayed.
So … feel free to play around with the component and if you find some errors or feel that something is missing, let me know! I will add some more stuff about custom themes the next couple of days and maybe make a Zend Framework theme for the recaptcha.
