README

Yii 2 Basic 项目模板

Yii 2 Basic 项目模板是一个用于快速创建小型项目的骨架Yii 2应用程序。

这是官方 Yii 2 Basic 项目模板的分支。

模板包含基本功能，包括用户登录/注销和联系页面。它包含所有常用配置，让您能够专注于添加新功能到您的应用程序。

以下模块包含在内

• raoul2000/yii2-bootswatch-asset：使用 Bootswatch 主题，在 Yii 应用程序中实现最小的工作量
• dektrium/user：为 Yii2 提供灵活的用户注册和认证模块
• dektrium/rbac：为 Yii2 提供的 RBAC 管理模块
• nemmo/yii2-attachments：文件上传和附加到模型的扩展
• bizley/migration：为 Yii 2 提供迁移生成器
• yii2mod/yii2-settings：Yii2 设置模块
• thrieu/yii2-grid-view-state：将 GridView 过滤器保存到会话中，保持页面之间的过滤状态。

它还包含一个 Lookups 模块和 CRUD，用于管理保存的 GridView 过滤器。

还包括 ActiveRecord 模型和 CRUD 页面的 Gii 模板。

目录结构

  assets/             contains assets definition
  commands/           contains console commands (controllers)
  config/             contains application configurations
  controllers/        contains Web controller classes
  data/               contains folders for database backups and uploaded files/attachments
  mail/               contains view files for e-mails
  models/             contains model classes
  modules/            contains application modules, currently that are `backuprestore` and `lookup`
  migrations/         contains database migrations to create tables needed
  myTemplates/        contains gii templates for models and CRUD pages
  rbac/               contains an example rule `Author` 
  runtime/            contains files generated during runtime
  tests/              contains various tests for the basic application
  vendor/             contains dependent 3rd-party packages
  views/              contains view files for the Web application
  web/                contains the entry script and Web resources
  widgets/            contains widhets, currently `Alert` and `GridView`

需求

本项目模板的最小需求是您的 Web 服务器支持 PHP 5.4.0。

安装

• 请参阅单独的文件 INSTALL.md

配置

• 请参阅单独的文件 INSTALL.md

测试

测试位于 tests 目录中。它们使用 Codeception PHP 测试框架 开发。默认情况下，有 3 个测试套件

• unit
• functional
• acceptance

可以通过以下命令执行测试

vendor/bin/codecept run

上述命令将执行单元测试和功能测试。单元测试用于测试系统组件，而功能测试用于测试用户交互。接受测试默认禁用，因为它们需要额外的设置，因为它们在真实浏览器中执行测试。

运行接受测试

要执行接受测试，请执行以下操作

1. 将 tests/acceptance.suite.yml.example 重命名为 tests/acceptance.suite.yml 以启用套件配置

2. 将 composer.json 中的 codeception/base 包替换为 codeception/codeception 以安装具有完整功能的 Codeception 版本

3. 使用 Composer 更新依赖项

    composer update  
   

4. 下载 Selenium 服务器 并启动它

    java -jar ~/selenium-server-standalone-x.xx.x.jar
   

   如果您使用的是从 v48 开始的 Firefox 浏览器或从 v53 开始的 Google Chrome 浏览器，并且使用 Selenium Server 3.0，则必须下载 GeckoDriver 或 ChromeDriver 并使用它启动 Selenium

    # for Firefox
    java -jar -Dwebdriver.gecko.driver=~/geckodriver ~/selenium-server-standalone-3.xx.x.jar
       
    # for Google Chrome
    java -jar -Dwebdriver.chrome.driver=~/chromedriver ~/selenium-server-standalone-3.xx.x.jar
   

   作为另一种方法，您可以使用已配置的带有旧版本 Selenium 和 Firefox 的 Docker 容器

    docker run --net=host selenium/standalone-firefox:2.53.0
   

5. （可选）创建 yii2_basic_tests 数据库，并应用迁移以更新它（如果您有迁移）。

   tests/bin/yii migrate
   

   数据库配置可以在 config/test_db.php 中找到。

1. 启动 Web 服务器

    tests/bin/yii serve
   

2. 现在您可以运行所有可用的测试

   # run all available tests
   vendor/bin/codecept run
   
   # run acceptance tests
   vendor/bin/codecept run acceptance
   
   # run only unit and functional tests
   vendor/bin/codecept run unit,functional
   

代码覆盖率支持

默认情况下，在 codeception.yml 配置文件中禁用了代码覆盖率，您应取消注释所需的行以能够收集代码覆盖率。您可以使用以下命令运行测试并收集覆盖率

#collect coverage for all tests
vendor/bin/codecept run -- --coverage-html --coverage-xml

#collect coverage only for unit tests
vendor/bin/codecept run unit -- --coverage-html --coverage-xml

#collect coverage for unit and functional tests
vendor/bin/codecept run functional,unit -- --coverage-html --coverage-xml

您可以在 tests/_output 目录下看到代码覆盖率输出。