Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lorddashme/php-simple-captcha
A simple captcha package that fit to any type of web application built on php.
https://github.com/lorddashme/php-simple-captcha
anti-spam captcha free php security simple
Last synced: about 2 months ago
JSON representation
A simple captcha package that fit to any type of web application built on php.
- Host: GitHub
- URL: https://github.com/lorddashme/php-simple-captcha
- Owner: LordDashMe
- License: mit
- Created: 2018-09-07T06:33:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-01T16:03:04.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T19:24:00.343Z (3 months ago)
- Topics: anti-spam, captcha, free, php, security, simple
- Language: PHP
- Homepage:
- Size: 850 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Simple Captcha
A simple captcha package that fit to any type of web application built on php.
[](https://packagist.org/packages/lorddashme/php-simple-captcha) [](https://php.net/) [](https://coveralls.io/github/LordDashMe/php-simple-captcha?branch=master)
## Sample
   
## Requirement(s)
- PHP version from 5.6.* up to latest.
## Install
- Recommended to install using Composer. Use the command below to install the package:
```txt
composer require lorddashme/php-simple-captcha
```
## Usage
### List of Available Functions
| Function | Description |
| -------- | ----------- |
| ```code(length);``` | Execute the generation of random code base on the given length.
The default length is 5. |
| ```image();``` | Execute the generation of image and the content will be base on the ```code(length);``` function. |
| ```getCode();``` | To get the current code generated by the ```code(length);``` method.
Ex. return value ```QwErTyx...``` |
| ```getImage();``` | To get the current image generated by the ```image();``` function.
Ex. return value ```data:image/png;base64,iVBORw0KGgoAA...``` |
| ```storeSession();``` | Use to store the generated values in the captcha session. |
| ```getSession();``` | Use to get the current stored session generated values in the captcha session. This is use to validate the generated code against the user organic inputed code.
Ex. return value ```array('code' => '...')``` |
- Basic usage:
```php
code();
// Execute the image captcha rendering.
$captcha->image();
// The generated captcha code, something like "QwErTyx..."
echo $captcha->getCode();
// The generated captcha image that include the code above.
// The output is base64 data image "data:image/png;base64,iVBORw0KGgoAA..."
echo $captcha->getImage();
```
- Also can be done by using the code below:
```php
code();
$captcha->image();
$captcha->storeSession();
?>
...
;%20?>)
```
- Validation Route:
- We need to initialize again the Captcha class but now we don't need to initialize the code and image generation.
- Validate the user inputed captcha code.
```php
getSession(); // return array( 'code' => 'QwErTyx...' )
if ($_POST['user_captcha_code'] === $data['code']) {
return 'Code is valid!';
} else {
return 'Code is invalid!';
}
```
- You may also check the [sample](sample) in the root directory of the package that will show you the actual example of implementing captcha class.
### Captcha Configuration
- To change the default config of the class:
```php
'ldm-simple-captcha',
'session_index_name' => 'LDM_SIMPLE_CAPTCHA',
'session_https' => false,
'session_http_only' => true,
'font_color' => '#000',
'font_size_min' => 26,
'font_size_max' => 28,
'angle_min' => 0,
'angle_max' => 9,
'shadow' => true,
'shadow_color' => '#fff',
'shadow_offset_x' => -3,
'shadow_offset_y' => 1,
'backgrounds' => array(
'bg1.png',
'bg2.png',
'bg3.png',
'bg4.png',
'bg5.png',
'bg6.png',
'bg7.png',
'bg8.png'
),
'fonts' => array(
'capsmall_clean.ttf'
)
);
$captcha = new Captcha($config);
// Or you can use this style.
CaptchaFacade::init($config);
```
### Tips
- Overriding the default config:
- The ```backgrounds``` and ```fonts``` are tightly coupled in the directory structure of the package.
- If you want to override the ```backgrounds``` and ```fonts``` you need to extends the Captcha class with your new sub class and override the protected methods of Captcha class for resources directory, ```backgroundsDirectoryPath()``` and ```fontsDirectoryPath```.
```php