blackknight467/ayah-bundle

Are you a human bundle for use with Symfony 2. This bundle adds the 'ayah' form type. Simple and easy to use. Lets leave the captcha behind

blackknight467's AYAHBundle

The AYAHBundle adds support for a "ayah" form type for the Symfony2 form component., _(*1)

Minimum Requirement: Symfony 2.7, _(*2)

NOTE: I am not in any way associated with Are you a human. I am just some guy who needed to implent are you human using symfony 2 forms and then decided to share his code to make life easier for anyone who wants to leave captchas behind., _(*3)

Installation

Step 1: Download the AYAHBundle

Using Composer, _(*4)

Add the following to the "require" section of your composer.json file:, _(*5)

    "blackknight467/ayah-bundle": "2.*"

Step 2: Enable the bundle

Finally, enable the bundle in the kernel:, _(*6)

<?php
// app/appKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new blackknight467\AYAHBundle\AYAHBundle(),
    );
}

Configuration

Add the following configuration to your app/config/config.yml:, _(*7)

ayah:
    publisher_key: 'your ayah publisher key here'
    scoring_key: 'your ayah scoring key here'

Advanced Configuration

The default error message for failing the are you a human test is:, _(*8)

'You did not pass the "Are You A Human" test. This is a problem. Study up and try again.', _(*9)

For a custom error message add the following to you app/config/config.yml:, _(*10)

ayah:
    error_message: 'your error message here'

Usage

<?php
    // ...
    $builder->add('ayah', 'ayah'); // That's all !
    // ...

Advanced Usage

If you need to skip the test scoring for some reason (e.g. automated testing) use the assume_human option., _(*11)

if assume_human is true, it turns off the form validation for of the are you a human field so no errors shall occur if the test is skipped., _(*12)

example:, _(*13)

<?php
    // ...
    $builder->add('ayah', 'ayah', array(
                'assume_human' => true
            ))

    // ...

License

This bundle is under the MIT license. See the complete license in the bundle: LICENSE, _(*14)