horat1us / yii2-model-schema
使用验证规则为 Yii2 模型生成 JSON Schema
1.3.0
2020-07-09 10:05 UTC
Requires
- php: >=7.4
- ext-json: *
- yiisoft/yii2: ^2.0.31
Requires (Dev)
- phpstan/phpstan: ^0.12.32
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.5
README
使用验证规则和其他公共方法从 Yii2 模型创建 JSON Schema。
安装
使用 composer
composer require horat1us/yii2-model-schema:^1.0
用法
base\Model 扩展
将在模型中实现时用于生成 JsonSchema 的附加接口。
属性示例
将被用于生成属性 示例
有关实现,请参阅 AttributesExamplesTrait (自 1.1.0)
<?php declare(strict_types=1); namespace App; use Horat1us\Yii\Model; use yii\base; $model = new class extends base\Model implements Model\AttributesExamples { use Model\AttributesExamplesTrait; public function attributesExamples(): array { return [ 'a' => [1,2], 'b' => [], ]; } }; echo $model->getAttributeExamples('a'); // [1,2] echo $model->getAttributeExamples('b'); // null echo $model->getAttributeExamples('c'); // null echo $model->getAttributeExample('a'); // 1 echo $model->getAttributeExample('b'); // null echo $model->getAttributeExample('c'); // null
待办事项
编写文档