roaresearch/yii2-formgenerator

用于配置表单生成器的Yii 2库

2.0.0 2020-01-10 15:51 UTC

This package is auto-updated.

Last update: 2024-09-24 03:09:42 UTC


README

用于在数据库中动态生成表单的库。

Latest Stable Version Total Downloads Code Coverage Scrutinizer Code Quality

Scrutinizer Build Status Scrutinizer Travis Build Status Travis

入门指南

以下说明将在您的本地机器上安装并运行项目的副本,用于开发和测试。有关如何部署到实时系统的说明,请参阅部署。

先决条件

其余要求将在下一步安装存储库时由Composer检查。

安装

您可以使用Composer通过运行以下命令安装库roaresearch/yii2-formgenerator;

composer require roaresearch/yii2-formgenerator

或编辑composer.json文件

require: {
    "roaresearch/yii2-formgenerator": "*",
}

部署

然后运行所需的迁移

php yii migrate/up -p=@roaresearch/formgenerator/migrations/tables

这将安装以下表结构

Database Diagram

ROA后端使用

ROA支持非常简单,只需向API容器添加一个模块版本即可,该容器将用于存储资源。

class Api extends \roaresearch\yii2\roa\modules\ApiContainer
{
   $versions = [
       // other versions
       'fg1' => ['class' => 'roaresearch\yii2\formgenerator\roa\modules\Version'],
   ];
}

然后您可以访问该模块以检查可用的资源。

  • data-type
  • field
  • field/<field_id:\d+>/rule
  • field/<field_id:\d+>/rule/<rule_id:\d+>/property
  • form
  • form/<form_id:\d+>/section
  • form/<form_id:\d+>/section/<section_id:\d+>/field
  • form/<form_id:\d+>/solicitude
  • form/<form_id:\d+>/solicitude/<solicitude_id:\d+>/value

这将实现表单生成器的CRUD功能。

或者,您可以将资源路由添加到现有版本中。

运行测试

此库包含使用Composer脚本设置测试环境的工具,有关更多信息,请参阅测试环境部分。

分解为端到端测试

一旦设置测试环境,运行以下命令。

composer deploy-tests

运行测试。

composer run-tests

运行带有覆盖率的测试。

composer run-coverage

实时演示

您可以在新安装的项目上运行实时演示,以帮助您运行测试或了解服务器返回的响应。实时演示可以通过以下命令初始化。

php -S localhost:8000 -t tests/_app

其中:8000是端口号,可以更改。这允许您在浏览器或REST客户端上调用ROA服务。

用例

待办事项

构建于

行为准则

请阅读CODE_OF_CONDUCT.md以了解我们的行为准则详情。

贡献

请阅读CONTRIBUTING.md以了解向提交拉取请求给我们的过程详情。

版本控制

我们使用 SemVer 进行版本控制。有关可用的版本,请参阅此存储库的标签

考虑到 SemVer 的版本控制规则 9、10 和 11 讨论了预发布版本,它们将不会在 ROAResearch 中使用。

作者

还可以参阅参与此项目的贡献者列表

许可

本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE.md 文件。