Elements

Captcha

Laminas\Form\Element\Captcha can be used with forms where authenticated users are not necessary, but you want to prevent spam submissions. It is paired with one of the Laminas\Form\View\Helper\Captcha\* view helpers that matches the type of CAPTCHA adapter in use.

Basic Usage

A CAPTCHA adapter must be attached in order for validation to be included in the element's input filter specification. See the laminas-captcha documentation for more information on what adapters are available.

use Laminas\Captcha;
use Laminas\Form\Element;
use Laminas\Form\Form;

$captcha = new Element\Captcha('captcha');
$captcha->setCaptcha(new Captcha\Dumb());
$captcha->setLabel('Please verify you are human');

$form = new Form('my-form');
$form->add($captcha);

Here is an example using array notation:

use Laminas\Captcha;
use Laminas\Form\Form;

$form = new Form('my-form');
$form->add([
    'type' => 'Laminas\Form\Element\Captcha',
    'name' => 'captcha',
    'options' => [
        'label' => 'Please verify you are human',
        'captcha' => new Captcha\Dumb(),
    ],
]);

Public Methods

The following methods are specific to the Captcha element; all other methods defined by the parent Element class are also available.