Captcha

Установка

С помощью composer:

{
    ...
    "require": {
        "gregwar/captcha": "1.*"
    }
}

Использование

Вы можете создать капчу с помощью CaptchaBuilder:

<?php

use Gregwar\Captcha\CaptchaBuilder;

$builder = new CaptchaBuilder;
$builder->build();

Затем вы можете сохранить его в файл:

<?php

$builder->save('out.jpg');

Или вывести напрямую:

<?php

header('Content-type: image/jpeg');
$builder->output();

Либо встроить непосредственно на HTML-страницу:

<img src="<?php echo $builder->inline(); ?>" />

У вас будет возможность получить код и сравнить его с пользовательским вводом:

<?php

// Пример: сохранение фразы в сессии для последующей проверки 
// пользовательского ввода
$_SESSION['phrase'] = $builder->getPhrase();

Можно сравнить фразу с пользовательским вводом:

if($builder->testPhrase($userInput)) {
    // инструкции, если пользовательская фраза хорошая
}
else {
    // пользовательская фраза плохая
}

API

Вы можете использовать следующие функции:

• construct($phrase = null) — создаёт конструктор с заданной фразой, если фраза равна нулю, генерируется случайная фраза;
• getPhrase() — позволяет получить содержимое фразы;
• setDistortion($distortion) — включает или отключает искажение, вызывается перед build();
• isOCRReadable() — возвращает true, если OCR можно прочитать с помощью программного обеспечения ocrad, вам потребуется включить shell_exec, установить imagemagick и ocrad;
• buildAgainstOCR($width = 150, $height = 40, $font = null) — генерирует код до тех пор, пока он не станет нечитаемым для ocrad;
• build($width = 150, $height = 40, $font = null) — создаёт код с заданными значениями ширины, высоты и шрифта. По умолчанию используется случайный шрифт из библиотеки;
• save($filename, $quality = 80) — сохраняет капчу в формате jpeg в $filename с заданным качеством;
• get($quality = 80) — возвращает данные jpeg;
• output($quality = 80) — напрямую выводит код jpeg в браузер;
• setBackgroundColor($r, $g, $b) — устанавливает цвет фона (это отключит многие эффекты, не рекомендуется);
• setBackgroundImages(array($imagepath1, $imagePath2)) — устанавливает пользовательские фоновые изображения для использования в качестве фона капчи. Рекомендуется отключать эффекты изображений при передаче пользовательских изображений для фона (ignore_all_effects). Выбирается случайное изображение из переданного списка, необходимо передать полные пути к файлам изображений;
• setInterpolation($interpolate) — включает или выключает интерполяцию (по умолчанию включена), отключение ускорит процесс, но изображения будут выглядеть хуже;
• setIgnoreAllEffects($ignoreAllEffects) — отключает все эффекты на изображении капчи. Рекомендуется использовать при передаче пользовательских фоновых изображений для капчи;
• testPhrase($phrase) — возвращает true, если заданная фраза хорошая;
• setMaxBehindLines($lines) — задаёт максимальное количество строк за кодом;
• setMaxFrontLines($lines) — задаёт максимальное количество линий перед кодом.

Symfony 2 Bundle

Для ознакомления с пакетом Symfony 2, который упаковывает этот генератор капчи, вы можете посетить следующий репозиторий: https://github.com/Gregwar/CaptchaBundle

Лицензия

Эта библиотека находится под лицензией MIT, ознакомьтесь с файлом LICENSE.