mkorkmaz/model_utils

一个简单的PHP类,用于验证变量类型、修复、清理并设置数组编码的模型定义的默认值。

1.1.11 2016-07-27 12:12 UTC

This package is auto-updated.

Last update: 2024-09-17 11:45:32 UTC


README

Circle CI Latest Stable Version Total Downloads Latest Unstable Version License Scrutinizer Code Quality Codacy Badge

一个简单的PHP类,用于验证变量类型、修复、清理并设置数组编码的模型定义的默认值。可以在插入或更新文档之前使用。

这个类是实验性的,默认行为不会改变,但可能存在一些需要修复的bug,并且需要扩展以处理不同类型的情况。

这个类可以作为完整的ORM/ODM的一部分使用,或在某些低级数据库操作脚本中使用。

模型定义

###_type: 定义变量类型。可能的值:布尔型、整数、浮点型、字符串、数组 ###_input_type: 定义更具体的输入类型。可能的值:布尔型、日期、时间、日期时间、时间戳、电子邮件、URL、IP、MAC地址或正则表达式 ###_input_format: 如果 _input_type 设置为正则表达式,则将文档项的值与该表达式进行测试。 ###_min_length: 如果是字符串,定义最小长度;如果是整数或浮点数,定义最小值 ###_max_length: 定义字符串的最大长度,如果是整数或浮点数,定义最大值 ###_required: 定义是否为必填文档项。目前类中未使用 ###_index: 定义文档项是否必须索引到数据库中。类中未使用,但在执行数据库操作时可以使用。 ###_default: 定义文档项的默认值。 ###_ref: 定义与其他文档的关系,如外键。类中未使用,但在执行数据库操作时可以使用。 ###_has_many: 定义与其他文档的关系,这些文档定义为子文档。类中未使用,但在执行数据库操作时可以使用。

ModelUtils::validateDoc

可以使用它来测试文档。可以在插入文档之前使用。如果存在冲突,验证会抛出异常。

ModelUtils::fitDocToModel

可以用于修复和清理部分文档。可以在更新文档之前使用。

ModelUtils::setModelDefaults

可以用于根据模型定义调整部分文档。可以在插入或更新文档之前使用。

安装

建议您使用 Composer 安装 ModelUtils。

$ composer require --prefer-dist mkorkmaz/model_utils "*"

这将安装 ModelUtils 及其所有必需的依赖项。ModelUtils 需要 PHP 5.4.0 或更高版本。crisu83/shortid 包需要支持短标识符。

用法

use ModelUtils\ModelUtils as ModelUtils;

$doc = ModelUtils::fitDocToModel($model, $doc);
$doc = ModelUtils::setModelDefaults($model, $doc);
ModelUtils::validateDoc($model, $doc);

请参阅 test.php

贡献

  • 如果发现bug,请打开问题或发送pull请求。
  • 如果您有任何问题,请随时提问。