gregwar / captcha
Captcha generator
Installs: 8 464 593
Dependents: 219
Suggesters: 8
Security: 0
Stars: 1 759
Watchers: 62
Forks: 297
Open Issues: 13
Requires
- php: >=5.3.0
- ext-fileinfo: *
- ext-gd: *
- ext-mbstring: *
- symfony/finder: *
Requires (Dev)
- phpunit/phpunit: ^4.8.35 || ^5.7.21 || ^6.4 || ^7.0 || ^8.0 || ^9.0
- dev-master
- v1.3.0
- v1.2.1
- v1.2.0
- v1.1.9
- v1.1.8
- v1.1.7
- v1.1.6
- v1.1.5
- v1.1.4
- v1.1.3
- v1.1.2
- v1.1.1
- v1.1
- v1.0.13
- v1.0.12
- v1.0.11
- v1.0.10
- v1.0.9
- v1.0.8
- v1.0.7
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0
- dev-dependabot/github_actions/actions/checkout-4
- dev-phpcs
- dev-phpstan
- dev-transparent-bg
- dev-image-type
- dev-tests
- dev-php84
This package is auto-updated.
Last update: 2025-06-23 14:02:24 UTC
README
Installation
With composer :
{ ... "require": { "gregwar/captcha": "1.*" } }
Usage
You can create a captcha with the CaptchaBuilder
:
<?php use Gregwar\Captcha\CaptchaBuilder; $builder = new CaptchaBuilder; $builder->build();
You can then save it to a file :
<?php $builder->save('out.jpg');
Or output it directly :
<?php header('Content-type: image/jpeg'); $builder->output();
Or inline it directly in the HTML page:
<img src="<?php echo $builder->inline(); ?>" />
You'll be able to get the code and compare it with a user input :
<?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:
if($builder->testPhrase($userInput)) { // instructions if user phrase is good } else { // user phrase is wrong }
API
You can use these functions :
- __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 theocrad
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:
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:
// 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
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
Yii2 Extension
You can use the following extension for integrating with Yii2 Framework : https://github.com/juliardi/yii2-captcha
License
This library is under MIT license, have a look to the LICENSE
file