Download the PHP package diversen/captcha without Composer
On this page you can find all versions of the php package diversen/captcha. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download diversen/captcha
More information about diversen/captcha
Files in diversen/captcha
Package captcha
Short Description Captcha generator
License MIT
Homepage https://github.com/diversen/Captcha
Informations about the package captcha
Captcha
NOTE. The 'Gregwar/Captcha' seems to be fixed, so no need to use this REPO.
Note this is just a fork of https://github.com/Gregwar/Captcha
Made because there is no updates to the package.
If the Gregwar/Captcha package is updated I will remove this package.
Installation
With composer :
composer require diversen/captcha
Usage
You can create a captcha with the CaptchaBuilder
:
You can then save it to a file :
Or output it directly :
Or inline it directly in the HTML page:
You'll be able to get the code and compare it with a user input :
You can compare the phrase with user input:
API
You can use theses 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 into a jpeg in the $filename, with the given quality
- get($quality = 80), returns the jpeg data
- output($quality = 80), directly outputs the jpeg code to a browser
- setBackgroundColor($r, $g, $b), sets the background color to force it (this will disable many effects and is not recommended)
- 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
If you want to change the number of character, you can call the phrase builder directly using extra parameters:
You can also pass directly the wanted phrase to the builder:
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