PHP Classes

File: readme

Recommend this page to a friend!
  Classes of musthafa  >  Customizable CAPTCHA  >  readme  >  Download  
File: readme
Role: Documentation
Content type: text/plain
Description: readme
Class: Customizable CAPTCHA
Generate and validate CAPTCHA images
Author: By
Last change:
Date: 7 years ago
Size: 1,532 bytes


Class file image Download
A fully-customizable captcha class.

Captcha is used to stop automated form submission.
This class can be used to generate custom captcha image for your website.
It also provides method to validate the captcha.

How to use

Start session
Instantiate Captcha class
Set captcha properties( background, text color, font etc.) using setXXX methods provided by the captcha object (optional).
Display image using showImage() method

	GD libraray ( freetype library support needed)
method summary

function showImage()
Generates captcha image. Outputs generated image in png format.

function setBGColor( $r, $g, $b )	
Sets the background color of captcha image.
Parameters: $r -> Red, $g -> green, $b -> blue. [ RGB format ]

function setFontSize( $size ) 
Sets the font size.
Parameter: $size -> The font size. Depending on your version of GD, 
this should be specified as the pixel size (GD1) or point size (GD2).

function setSize( $width, $height )
Sets the captcha images size.
Parameters : $width -> image width, $height -> image height.

function setFont( $font )
Sets the font of captcha.
Parameter: $font -> path to TrueType font file.

function setTextColor( $r, $g, $b )
Sets the captcha text color.
Parameters: $r -> Red, $g -> green, $b -> blue. [ RGB format ]

public static function isValid( $code )
Validates captcha. if valid returns true, otherwise false. 
Parameter: $code -> user input to be validated