GUMP 使用与技术文档

1. 安装指南

GUMP 是一个独立的 PHP 数据验证和过滤类，能够轻松验证任何数据，无需依赖框架。GUMP 自 2013 年起开源。

GUMP 支持广泛的 PHP 版本（从 php7.1 到 php8.3），且 无任何依赖！

要安装 GUMP，可以使用 Composer 工具执行以下命令：

composer require wixel/gump

2. 项目使用说明

GUMP 提供了简短和详细两种格式的验证和过滤方法。

验证示例

简短格式：

/is_valid = GUMP::is_valid(array_merge($_POST, $_FILES), [
    'username'       => 'required|alpha_numeric',
    'password'       => 'required|between_len,4;100',
    'avatar'         => 'required_file|extension,png;jpg',
    'tags'           => 'required|alpha_numeric',
    'person.name'    => 'required',
    'persons.*.age'  => 'required'
]);

长格式：

$gump = new GUMP();

// 设置验证规则
$gump->validation_rules([
    'username'    => 'required|alpha_numeric|max_len,100|min_len,6',
    'password'    => 'required|max_len,100|min_len,6',
    'email'       => 'required|valid_email',
    'gender'      => 'required|exact_len,1|contains,m;f',
    'credit_card' => 'required|valid_cc'
]);

// 设置字段规则特定的错误信息
$gump->set_fields_error_messages([
    'username'      => ['required' => '请填写用户名，这是必填项。'],
    'credit_card'   => ['extension' => '请输入有效的信用卡号。']
]);

// 设置过滤规则
$gump->filter_rules([
    'username' => 'trim|sanitize_string',
    'password' => 'trim',
    'email'    => 'trim|sanitize_email',
    'gender'   => 'trim',
    'bio'      => 'noise_words'
]);

$valid_data = $gump->run($_POST);

if ($gump->errors()) {
    var_dump($gump->get_readable_errors());
    // 或者
    var_dump($gump->get_errors_array());
} else {
    var_dump($valid_data);
}

过滤示例

$filtered = GUMP::filter_input([
    'field'       => ' text ',
 'other_field' => 'Cool Title'
], [
 'field'       => ['trim', 'upper_case'],
 'other_field' => 'slug'
]);

var_dump($filtered['field']); // 输出: "TEXT"
var_dump($filtered['other_field']); // 输出: "cool-title"

3. 项目API使用文档

以下是 GUMP 类提供的一些重要方法：

• is_valid($data, $rules, $custom_messages = []): 验证数据是否符合规则。
• filter_input($data, $rules): 过滤数据。
• set_fields_error_messages($messages): 设置字段规则的错误信息。
• validation_rules($rules): 设置验证规则。
• filter_rules($rules): 设置过滤规则。
• run($data): 运行验证和过滤。
• errors(): 检查是否有错误。
• get_readable_errors(): 获取可读的错误信息。
• get_errors_array(): 获取错误信息数组。

更多方法请参考官方文档。

4. 项目安装方式

如安装指南所述，使用 Composer 是最简单的方法：

composer require wixel/gump

确保你的系统中已经安装了 Composer。如果没有，请先安装 Composer。