首先使用`Composer`安裝`think-captcha`擴展包:
~~~
composer require topthink/think-captcha
~~~
>[danger] 官方的`5.0`版本的擴展庫版本號都是`1.*`,`2.0`版本均為ThinkPHP`5.1`版本專用。
## 驗證碼的簡單用法
擴展包內定義了一些常見用法方便使用,以下示例說明
>[danger] 注意:需要開啟URL路由。
模版內驗證碼的顯示
~~~
<div>{:captcha_img()}</div>
~~~
或者
~~~
<div><img src="{:captcha_src()}" alt="captcha" /></div>
~~~
>[info]上面兩種的最終效果是一樣的,根據需要調用即可。
使用TP5的內置驗證功能,添加`captcha`驗證規則即可
~~~
$this->validate($data,[
'captcha|驗證碼'=>'require|captcha'
]);
~~~
或者手動驗證
~~~
if(!captcha_check($captcha)){
//驗證失敗
};
~~~
## 驗證碼的自定義用法
如果項目未開啟路由,或者有實際需求可自行調用`Captcha`類操作
驗證碼的生成:
~~~
$captcha = new Captcha();
return $captcha->entry();
~~~
如果你需要在一個頁面中生成多個驗證碼的話,entry方法需要傳入可標識的信息,例如:
~~~
$captcha = new Captcha();
return $captcha->entry(1);
~~~
驗證碼的驗證:
可以用`Captcha`類的check方法檢測驗證碼的輸入是否正確,例如,下面是封裝的一個驗證碼檢測的函數:
~~~
// 檢測輸入的驗證碼是否正確,$code為用戶輸入的驗證碼字符串,$id多個驗證碼標識
function check_verify($code, $id = ''){
$captcha = new Captcha();
return $captcha->check($code, $id);
}
~~~
## 驗證碼的配置參數
`Captcha`類帶有默認的配置參數,支持自定義配置。這些參數包括:
>[info] 如果使用了擴展內置的方法,務必在應用配置文件中配置,`5.0.1`及以上支持者在應用配置目錄下面extra子目錄內配置`captcha.php`文件
| 參數 | 描述 | 默認 |
| --- | --- | --- |
| codeSet | 驗證碼字符集合 | 略 |
| expire | 驗證碼過期時間(s) | 1800 |
| useZh | 使用中文驗證碼 | false |
| zhSet | 中文驗證碼字符串 | 略 |
| useImgBg | 使用背景圖片 | false |
| fontSize | 驗證碼字體大小(px) | 25 |
| useCurve | 是否畫混淆曲線 | true |
| useNoise | 是否添加雜點 | true |
| imageH | 驗證碼圖片高度,設置為0為自動計算 | 0 |
| imageW | 驗證碼圖片寬度,設置為0為自動計算 | 0 |
| length | 驗證碼位數 | 5 |
| fontttf | 驗證碼字體,不設置是隨機獲取 | 空 |
| bg | 背景顏色 | [243, 251, 254] |
| reset | 驗證成功后是否重置 | true |
參數設置使用兩種方式。
實例化傳入參數:
~~~
$config = [
// 驗證碼字體大小
'fontSize' => 30,
// 驗證碼位數
'length' => 3,
// 關閉驗證碼雜點
'useNoise' => false,
];
$captcha = new Captcha($config);
return $captcha->entry();
~~~
或者采用動態設置的方式,如:
~~~
$captcha = new Captcha();
$captcha->fontSize = 30;
$captcha->length = 3;
$captcha->useNoise = false;
return $captcha->entry();
~~~
驗證碼字體
默認情況下,驗證碼的字體是隨機使用擴展包內 `think-captcha/assets/ttfs`目錄下面的字體文件,我們可以指定驗證碼的字體,例如:
~~~
$captcha = new Captcha();
$captcha->fontttf = '5.ttf';
return $captcha->entry();
~~~
背景圖片
支持驗證碼背景圖片功能,可以如下設置:
~~~
$captcha = new Captcha();
// 開啟驗證碼背景圖片功能 隨機使用擴展包內`think-captcha/assets/bgs`目錄下面的圖片
$captcha->useImgBg = true;
return $captcha->entry();
~~~
中文驗證碼
如果要使用中文驗證碼,可以設置:
~~~
$captcha = new Captcha();
//中午 驗證碼字體使用擴展包內`think-captcha/assets/zhttfs`字體文件
$captcha->useZh = true;
return $captcha->entry();
~~~
指定驗證碼字符
指定驗證碼的字符,可以設置:
~~~
$captcha = new Captcha();
// 設置驗證碼字符為純數字
$captcha->codeSet = '0123456789';
return $captcha->entry();
~~~
如果是中文驗證碼,可以使用`zhSet`參數設置,例如:
~~~
$captcha = new Captcha();
$captcha->useZh = true;
// 設置驗證碼字符
$captcha->zhSet = '們以我到他會作時要動國產的一是工就年階義發成部民可出能方進在了不和有大這';
return $captcha->entry();
~~~
>[info] 默認的驗證碼字符已經剔除了易混淆的`1l0o`等字符
- 序言
- 基礎
- 安裝ThinkPHP
- 開發規范
- 目錄結構
- 架構
- 架構總覽
- 生命周期
- 入口文件
- URL訪問
- 模塊設計
- 命名空間
- 自動加載
- Traits引入
- API友好
- 配置
- 配置目錄
- 配置格式
- 配置加載
- 讀取配置
- 動態配置
- 獨立配置
- 配置作用域
- 環境變量配置
- 路由
- 路由模式
- 路由定義
- 批量注冊
- 變量規則
- 組合變量
- 路由參數
- 路由地址
- 資源路由
- 快捷路由
- 路由別名
- 路由分組
- MISS路由
- 閉包支持
- 路由綁定
- 綁定模型
- 域名路由
- URL生成
- 控制器
- 控制器定義
- 控制器初始化
- 前置操作
- 跳轉和重定向
- 空操作
- 空控制器
- 多級控制器
- 分層控制器
- Rest控制器
- 自動定位控制器
- 資源控制器
- 請求
- 請求信息
- 輸入變量
- 更改變量
- 請求類型
- 請求偽裝
- HTTP頭信息
- 偽靜態
- 方法注入
- 屬性注入
- 參數綁定
- 依賴注入
- 請求緩存
- 數據庫
- 連接數據庫
- 基本使用
- 查詢構造器
- 查詢數據
- 添加數據
- 更新數據
- 刪除數據
- 查詢方法
- 查詢語法
- 鏈式操作
- where
- table
- alias
- field
- order
- limit
- page
- group
- having
- join
- union
- distinct
- lock
- cache
- comment
- fetchSql
- force
- bind
- partition
- strict
- failException
- sequence
- 聚合查詢
- 時間查詢
- 高級查詢
- 視圖查詢
- 子查詢
- 原生查詢
- 查詢事件
- 事務操作
- 監聽SQL
- 存儲過程
- 數據集
- 分布式數據庫
- 模型
- 定義
- 模型初始化
- 新增
- 更新
- 刪除
- 查詢
- 聚合
- 獲取器
- 修改器
- 時間戳
- 只讀字段
- 軟刪除
- 類型轉換
- 數據完成
- 查詢范圍
- 模型分層
- 數組訪問和轉換
- JSON序列化
- 事件
- 關聯
- 一對一關聯
- 一對多關聯
- 遠程一對多
- 多對多關聯
- 多態關聯
- 動態屬性
- 關聯預載入
- 關聯統計
- 聚合模型
- 視圖
- 視圖實例化
- 模板引擎
- 模板賦值
- 模板渲染
- 輸出替換
- 模板
- 模板定位
- 模板標簽
- 變量輸出
- 系統變量
- 請求參數
- 使用函數
- 使用默認值
- 使用運算符
- 三元運算
- 原樣輸出
- 模板注釋
- 模板布局
- 模板繼承
- 包含文件
- 標簽庫
- 內置標簽
- 循環輸出標簽
- 比較標簽
- 條件判斷
- 資源文件加載
- 標簽嵌套
- 原生PHP
- 定義標簽
- 日志
- 介紹
- 日志驅動
- 日志寫入
- 獨立日志
- 日志清空
- 寫入授權
- 錯誤和調試
- 調試模式
- 異常處理
- 拋出異常
- Trace調試
- 變量調試
- 性能調試
- SQL調試
- 遠程調試
- 404頁面
- 驗證
- 驗證器
- 驗證規則
- 錯誤信息
- 驗證場景
- 控制器驗證
- 模型驗證
- 內置規則
- 靜態調用
- 表單令牌
- 安全
- 輸入安全
- 數據庫安全
- 上傳安全
- 其它安全建議
- 雜項
- 緩存
- Session
- Cookie
- 多語言
- 分頁
- 上傳
- 驗證碼
- 圖像處理
- 文件處理
- 單元測試
- 擴展
- 函數
- 類庫
- 行為
- 驅動
- Composer包
- Time
- 數據庫遷移工具
- Workerman
- MongoDb
- SAE
- 標簽擴展
- 命令行
- 自動生成目錄結構
- 創建類庫文件
- 生成類庫映射文件
- 生成路由緩存
- 清除緩存文件
- 生成配置緩存文件
- 生成數據表字段緩存
- 自定義命令行
- 部署
- 虛擬主機環境
- Linux 主機環境
- URL重寫
- 附錄
- 配置參考
- 常量參考
- 助手函數
- 升級指導
- 更新日志