https://github.com/myaaghubi/f3-captcha

A better captcha for Fat-Free Framework.
https://github.com/myaaghubi/f3-captcha

captcha f3-captcha fat-free-plugin fatfree-framework

Last synced: about 2 months ago
JSON representation

A better captcha for Fat-Free Framework.

• Host: GitHub
• URL: https://github.com/myaaghubi/f3-captcha
• Owner: myaaghubi
• License: gpl-3.0
• Created: 2020-09-29T06:50:47.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-24T08:22:39.000Z (over 3 years ago)
• Last Synced: 2024-10-11T21:53:51.956Z (2 months ago)
• Topics: captcha, f3-captcha, fat-free-plugin, fatfree-framework
• Language: PHP
• Homepage:
• Size: 85 KB
• Stars: 7
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# F3 Captcha

A better captcha for Fat-Free Framework.

![screenshot-english](screenshots/shot1.jpg?raw=true "F3 Captcha Screentshot-English Font") ![screenshot-persian](screenshots/shot2.jpg?raw=true "F3 Captcha Screentshot-Persian Font")

## Config

This plugin is configurable via config file:

``` ini

[captcha]

LENGTH=5

CASE_SENSITIVE=TRUE

WIDTH=150

HEIGHT=70

FONT=monofont.ttf

FONT_SCALE=0.65

WAVES=TRUE

LETTERS=123456789abcdefghijklmnopkrstuvwxyz

KEY=captcha_code

```

The above config is the default, you can ignore/remove each one you don't need to change.

## Usage

### 1. Install

If you use composer, run the below code:

```

composer require myaghobi/f3-captcha

```

For manual installation:

1. Copy the content of `lib/` folder into your `lib/` folder. 

2. Copy content of `ui/` into your `ui/` folder.

### 2. Routing

To show the captcha, you need to add a new route:

``` php

$f3->route('GET /captcha', 'Captcha->makeCaptchaImage');

```

### 3. Serve

Within your controller you need to serve the captcha:

``` php

$f3->set('captcha', \Captcha::instance()->serve());

```

And in your HTML template:

``` html

{{@captcha|raw}}

```

### 4. Verification

Finally you need to verify entered security code:

``` php

if (\Captcha::verify()) {

...

```

## Customization

### - Style

The default captcha template can be changed by the developer, check out `ui/captcha/captcha.html`.

### - Font

The default font is `monofont.ttf`, you can add your font in `ui/fonts/` and set the font name in config file.

## License

You are allowed to use this plugin under the terms of the GNU General Public License version 3 or later.

Copyright (C) 2021 Mohammad Yaghobi