gregwar/captcha

Captcha generator

Tuesday, April 24, 2018
by Gregwar
Repository
43 Watchers
850 Stars
1,540,350 Installations

PHP
163 Dependents
5 Suggesters
174 Forks
11 Open issues
22 Versions
7 % Grown

The README.md

Captcha

Captchas examples , _(*1)

Installation

With composer :, _(*2)

``` json { ... "require": { "gregwar/captcha": "1.*" } }, _(*3)


Usage
=====

You can create a captcha with the `CaptchaBuilder` :

```php
build();
```

You can then save it to a file :

```php
save('out.jpg');
```

Or output it directly :

```php
output();
```

Or inline it directly in the HTML page:

```php


You'll be able to get the code and compare it with a user input :, _(*4)

<?php

// Example: storing the phrase in the session to test for the user 
// input later
$_SESSION['phrase'] = $builder->getPhrase();


You can compare the phrase with user input:, _(*5)


if($builder->testPhrase($userInput)) {
    // instructions if user phrase is good
}
else {
    // user phrase is wrong
}

API
You can use these functions :, _(*6)

__construct($phrase = null), constructs the builder with the given phrase, if the phrase is null, a random one will be generated
getPhrase(), allow you to get the phrase contents
setDistortion($distortion), enable or disable the distortion, call it before build()
isOCRReadable(), returns true if the OCR can be read using the ocrad software, you'll need to have shell_exec enabled, imagemagick and ocrad installed
buildAgainstOCR($width = 150, $height = 40, $font = null), builds a code until it is not readable by ocrad
build($width = 150, $height = 40, $font = null), builds a code with the given $width, $height and $font. By default, a random font will be used from the library
save($filename, $quality = 80), saves the captcha in the $filename, with the given quality
get($quality = 80), returns the image data
output($quality = 80), directly outputs the image
inline($quality = 80), returns the jpeg code directly in the HTML page
setBackgroundColor($r, $g, $b), sets the background color to force it (this will disable many effects and is not recommended)
setBackgroundAlpha($alpha), sets the background transparency 0 is fully opaque, 127 is fully transparent
setBackgroundImages(array($imagepath1, $imagePath2)), Sets custom background images to be used as captcha background. It is recommended to disable image effects when passing custom images for background (ignore_all_effects). A random image is selected from the list passed, the full paths to the image files must be passed.
setInterpolation($interpolate), enable or disable the interpolation (enabled by default), disabling it will be quicker but the images will look uglier
setIgnoreAllEffects($ignoreAllEffects), disable all effects on the captcha image. Recommended to use when passing custom background images for the captcha.
testPhrase($phrase), returns true if the given phrase is good
setMaxBehindLines($lines), sets the maximum number of lines behind the code
setMaxFrontLines($lines), sets the maximum number of lines on the front of the code
setImageType($type), sets the image output type to "jpeg", "png" or "gif"
setScatterEffect($bool), enable or disable scatter effect (fuzzyness)

If you want to change the number of character, you can call the phrase builder directly using extra parameters:, _(*7)

use Gregwar\Captcha\CaptchaBuilder;
use Gregwar\Captcha\PhraseBuilder;

// Will build phrases of 3 characters
$phraseBuilder = new PhraseBuilder(4);

// Will build phrases of 5 characters, only digits
$phraseBuilder = new PhraseBuilder(5, '0123456789');

// Pass it as first argument of CaptchaBuilder, passing it the phrase
// builder
$captcha = new CaptchaBuilder(null, $phraseBuilder);

You can also pass directly the wanted phrase to the builder:, _(*8)

// Building a Captcha with the "hello" phrase
$captcha = new CaptchaBuilder('hello');

Complete example

If you want to see an example you can have a look at the demo/form.php, which uses demo/session.php to render a captcha and check it after the submission, _(*9)

Symfony Bundle

You can have a look at the following repository to enjoy the Symfony 2 bundle packaging this captcha generator : https://github.com/Gregwar/CaptchaBundle, _(*10)

Yii2 Extension

You can use the following extension for integrating with Yii2 Framework : https://github.com/juliardi/yii2-captcha, _(*11)

License

This library is under MIT license, have a look to the LICENSE file, _(*12)

The Versions

24/04 2018

dev-master

9999999-dev https://github.com/Gregwar/Captcha

Captcha generator

captcha captcha

Captcha generator

gregwar/captcha

The README.md

Captcha

Installation

API

Complete example

Symfony Bundle

Yii2 Extension

License

The Versions

dev-master

The Requires

The Development Requires

by Grégoire Passault

by Jeremy Livingston

v1.1.6

The Requires

The Development Requires

by Grégoire Passault

by Jeremy Livingston

v1.1.5

The Requires

The Development Requires

by Grégoire Passault

by Jeremy Livingston

v1.1.4

The Requires

The Development Requires

by Grégoire Passault

by Jeremy Livingston

v1.1.3

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.1.2

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.13

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.1.1

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.1

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.12

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.11

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.10

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.9

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.8

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.7

The Requires

by Grégoire Passault

by Jeremy Livingston

v1.0.6

The Requires

by Grégoire Passault

by Jeremy Livingston