README

关于

这是一个新 CakePHP 项目的模板。

由 Qobo 开发，用于 Qobrix。

安装

有两种方式可以安装并开始使用此项目模板。

Composer

您可以使用 composer 从此模板创建新项目。

composer create-project qobo/project-template-cakephp example.com
cd example.com
./bin/build app:install DB_NAME="app",PROJECT_NAME="My Project",PROJECT_VERSION="v1.0.0"

Git

或者，如果您想能够将项目更新到模板的最新版本，您可以使用 git 安装模板。

mkdir example.com
cd example.com
git init
# Pull the latest version from https://github.com/QoboLtd/project-template-cakephp/releases
git pull git@github.com:QoboLtd/project-template-cakephp.git vX.Y.Z
composer update
./bin/build app:install DB_NAME="app",PROJECT_NAME="My Project",PROJECT_VERSION="v1.0.0"
# Add your own remote repository
git remote add origin git@github.com/USER/REPO
# Push
git push origin master

使用上述方法，您将拥有模板开发的完整历史记录。现在您可以开始自己的开发，并在未来的任何时间升级到最新模板。

更新

如果您使用 git 安装了项目模板，您可以使用以下方法轻松将应用程序升级到最新模板

cd exmample.com
# Make sure you are on the master branch and have a clean and up-to-date workspace
git checkout master
git pull origin master
# Create a new branch
git checkout -b project-template-update
# Pull the latest version from https://github.com/QoboLtd/project-template-cakephp/releases
git pull git@github.com:QoboLtd/project-template-cakephp.git vX.Y.Z
composer update
./bin/build app:update
# Check for conflicts, resolve if any, commit, and then push
git push origin project-template-update
# Create a pull request, review, and merge

使用

PHP

现在您已经安装了项目模板，在开始修改之前请检查它是否工作正常。启动 PHP 网络服务器

./bin/phpserv

或在备用端口上运行它

./bin/phpserv -H localhost -p 9000

在浏览器中导航到 http://localhost:8000。您应该看到登录页面。如果看到了，所有部分都已就位。

现在您可以像平常一样开发您的 PHP 项目，但有以下优势

• 支持 PHP 内置网络服务器
• 使用 .env 文件按环境进行配置，该文件被 git 忽略
• 集成强大的构建系统（Robo）
• Composer 与 vendor/ 文件夹集成，并添加到 .gitignore 中
• PHPUnit 与 tests/ 文件夹和示例单元测试集成
• 默认值合理，遵循最佳实践 - favicon.ico、robots.txt、MySQL 备份、Nginx 配置、GPL 等。

例如，您可以通过修改包含在 build/ 文件夹中的 Robo 文件来轻松自动化应用程序的构建过程。运行以下命令来查看可用的目标

./bin/build

如您所见，已经为应用程序的构建过程预留了一些占位符。默认情况下，建议您有以下这些

• app:install - 用于应用程序的安装过程
• app:update - 用于已安装应用程序的更新过程
• app:remove - 用于应用程序的删除过程和清理

当然，您可以添加自己的，移除这些或以任何方式更改它们。查看Robo文档以获取有关如何使用这些目标和传递运行时配置参数的更多信息。

JavaScript

模板使用VueJS作为主要的JavaScript库。我们正在逐渐放弃jQuery代码库，将所有内容转移到Vue组件中。

为了运行代码的JavaScript部分，特别是如果您想检查模块搜索的工作方式，您必须首先编译JS组件。

项目将依赖于LTS版本的NodeJS。您可以按照此说明在您的机器上设置Node和npm。

您必须使用此命令安装package.json中所需的所有模块

npm install

在project-template-cakephp中，我们提供了package-lock.json，以确保代码库针对这些版本进行了适当的测试。

在package.json中，您可以找到运行以下操作的主要脚本命令

• npm run build:dev - 运行HRM版本的JavaScript
• npm run build:prod - 在webroot/dist/目录中编译生产就绪代码。
• npm run watch - 使用webpack的watch选项保持开发版本的代码在webroot/dist中。这对于检查代码在PHP应用程序中的外观非常有用。
• npm run lint - 运行ESLint检查
• npm run test - 使用jest运行单元测试。

测试

PHPUnit和PHP CodeSniffer

运行PHPUnit和PHP CodeSniffer最快、最简单的方法是通过composer脚本

./bin/composer test

或者，您可以通过代码覆盖率报告运行测试

./bin/composer test-coverage

HTML格式的代码覆盖率报告将放置在./build/test-coverage/文件夹中。

Travis CI

持续集成是一种工具，它帮助您在代码库上（提交、合并等）进行任何更改时运行您的测试。您可以使用许多工具，但project-template-cakephp提供了一个与Travis CI的示例集成。

查看.travis.yml文件，它描述了环境矩阵、项目安装步骤以及运行测试套件的方式。对于基于project-template-cakephp的真实项目，您可能希望从文件中删除示例测试。

示例

project-template-cakephp提供了一些关于如何编写和组织单元测试的示例。请查看tests/文件夹。现在您没有理由不测试您的应用程序了！

已知问题

MySQL 5.7 / MariaDB 10

使用MySQL 5.7或MariaDB 10运行此项目模板有时会导致SQL查询出现致命错误。我们正在寻找更好的方法来捕获和修复这些问题，但如果您在环境中遇到这些问题，请调整您的MySQL / MariaDB配置以使用SQL模式。

可以通过以下方式在etc/my.cnf文件中设置SQL模式

[mysqld]
sql-mode="NO_ZERO_IN_DATE,NO_ZERO_DATE"

或者，也可以通过SQL查询进行设置，如下所示

mysql > SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''));

有关更多信息，请参阅此StackOverflow线程。

以下是一些问题示例及其修复方法。

Error: SQLSTATE[22007]: Invalid datetime format: 1292 Incorrect datetime
value: '2017-11-30T13:30:48+02:00' for column 'timestamp' at row 1

如果您遇到上述错误（通常在Fedora 27及以上版本中看到），请确保您的SQL模式包含"NO_ZERO_IN_DATE,NO_ZERO_DATE"。

Error: SQLSTATE[42000]: Syntax error or access violation: 1055 Expression #1 of
SELECT list is not in GROUP BY clause and contains nonaggregated column ...

如果您遇到上述错误（通常在Ubuntu 16.05中看到），请确保您的SQL模式不包含"ONLY_FULL_GROUP_BY"。