README

Generate captcha image without using fonts, splitted captcha image or make animated GIF captcha.

Installation

With composer:

composer require dubashi/simple-captcha-php

Usage

You can create a simple captcha :

<?php
use Dubashi\SimpleCaptcha;

// create your own code
$code = '0123';

// Output http-response with captcha image
(new SimpleCaptcha())->create( $code )->output();

Or can create animated captcha :

<?php
use Dubashi\SimpleCaptcha;

// create your own code
$code = '0123';

// Create animated GIF captcha and save it into file
$captcha = (new SimpleCaptcha([
      'type'      => \IMAGETYPE_GIF,
      'thickness' => 5,
    ]))
    ->create( $code )       // create captcha with "code"
    ->split( 3 )            // split into 3 parts/frames
    ->outputFile('captcha') // save into file "captcha.gif"
  ;
  
// ..and get base64 data of image for own usage
$dataBase64 = $captcha->dataUri();

// ..or just output <img> tag into yours html-templaters
$captcha->outputImgHtml();

Options

You can use theses options :

• width, Width of result image(s) in pixels. Default: 100
• height, Height of result image(s) in pixels. Default: 50
• type, Type of result image(s). One of GD constants. Default: IMAGETYPE_JPEG
• thickness, Thinkness line of symbols in pixels. Default: 2
• colorFont, Font color. Array Red, Green, Blue color decimal component. Default: array( 30, 40, 50 )
• colorBackground, Background color. Default: array( 255, 255, 255 )
• dashed, Flag for use dashed line style. Default: false
• randPos, Flag for enable random position of verticies each one symbols. Default: false
• randPointPos, Flag for enable random position of verticies point scheme. Default: false
• randSym, Flag for use random symbols scheme. Default: false
• emboss, Flag for use emboss filter for image. Default: false
• nightmare, Flag for added more nightmare for bots and your users. Default: false
• gradient, Add gradient to image. Signed integer as -1, 0, 1. Default: 0 (none)
• noise, Add noise. Percent of count all pixels of image. Use sign to add noise after rendering captcha. Default: 0
• duration, The duration for GIF frames (in 1/100s). Default: 2
• loop, Loop GIF frames. Default: 0 (infinity)

API

You can use theses methods :

• create( $code ), Create Simple Captcha image with specified string code
• output(), Output image into stdout or browser
• outputFile(), Save Simple Captcha image(s) into file
• outputDataUri(), Output base64 encoded data of specified part of image
• dataUri(), Returns base64 encoded data of specified part of image
• outputImgHtml(), Output IMG tag
• imgHtml(), Returns IMG tag with captcha image(s)
• split(), Split source captcha image to parts
• setSymbolsScheme(), Set your own symbols scheme. See description of this method in code

License

This library is under MIT license, have a look to the LICENSE file