ronaldroyce/zend-commandline-skeleton

Zend 框架命令行管理界面的骨架应用

1.0.1 2019-07-20 16:14 UTC

This package is auto-updated.

Last update: 2024-09-19 18:39:28 UTC


README

简介

这是一个使用 Zend 框架 MVC 层和模块系统的骨架应用。此应用旨在作为那些想开始使用 Zend 框架的人的起点。它提供了一个命令行界面来管理 zend 对象。

使用 Composer 安装

创建新的 Zend 框架项目的最简单方法是使用 Composer。如果您尚未安装它,请根据文档进行安装。

创建您的新的 Zend 框架项目

$ composer create-project -sdev ronaldroyce/zend-commandline-skeleton path/to/install

安装完成后,您可以使用 PHP 内置的 Web 服务器立即测试它

$ cd path/to/install
$ php -S 0.0.0.0:8088 -t public/ public/index.php
# OR use the composer alias:
$ composer run --timeout 0 serve

这将启动端口 8080 上的 cli-server,并将其绑定到所有网络接口。然后您可以通过 https://:8080/ 访问网站

  • 它将显示 Zend 框架欢迎页面。

注意: 内置的 CLI 服务器仅用于开发。

开发模式

骨架默认包含 zf-development-mode,并提供三个别名来使用它所提供的脚本

$ composer development-enable  # enable development mode
$ composer development-disable # disable development mode
$ composer development-status  # whether or not development mode is enabled

您可以在 config/development.config.php.dist 中提供开发模块和引导级别的配置,以及在 config/autoload/development.local.php.dist 中提供开发应用程序配置。启用开发模式将复制这些文件,删除 .dist 后缀的版本,而禁用开发模式将删除这些副本。

开发模式是骨架安装过程的一部分自动启用。在修改上述提到的 .dist 配置文件之一后,您可能需要禁用然后启用开发模式,以便更改生效,或者手动对那些没有 .dist 后缀的文件副本进行匹配的更新。

运行单元测试

要运行提供的骨架单元测试,您需要执行以下操作之一

  • 在项目创建初期,选择安装 MVC 测试支持。

  • 在项目创建后,安装 zend-test

    $ composer require --dev zendframework/zend-test

一旦测试支持存在,您可以使用以下命令运行测试

$ ./vendor/bin/phpunit

如果您需要对 PHPUnit 测试设置进行本地修改,将 phpunit.xml.dist 复制到 phpunit.xml 并编辑新文件;后者在运行测试时具有优先权,并被版本控制忽略。(如果您想永久修改,请编辑 phpunit.xml.dist 文件。)

使用 Vagrant

此骨架包括基于 ubuntu 16.04(bento box)的 Vagrantfile,配置了 Apache2 和 PHP 7.0。使用以下命令启动它

$ vagrant up

一旦构建完成,您也可以在虚拟机内部运行 composer。例如,以下命令将安装依赖项

$ vagrant ssh -c 'composer install'

这将更新它们

$ vagrant ssh -c 'composer update'

运行时,Vagrant 将您的宿主机的 8080 端口映射到虚拟机的 80 端口;您可以通过 https://:8080/ 访问网站

Vagrant 和 VirtualBox

此 vagrant 映像基于 ubuntu/xenial64。如果您使用 VirtualBox 作为提供商,您将需要

  • 支持 Vagrant 1.8.5 或更高版本
  • 支持 VirtualBox 5.0.26 或更高版本

有关 Vagrant 文档,请参阅 vagrantup.com

使用 docker-compose

该骨架提供了一个用于 docker-composedocker-compose.yml 文件,它使用提供的 Dockerfile 作为其基础。使用以下命令构建并启动镜像:

$ docker-compose up -d --build

此时,您可以通过访问 https://:8080 来查看正在运行的网站。

您还可以从镜像中运行 composer。容器环境名为 "zf",因此您需要在 docker-compose run 中传递该值。

$ docker-compose run zf composer install

Web 服务器配置

Apache 配置

要配置 Apache,请设置一个虚拟主机,使其指向项目的 public/ 目录,然后您就可以开始使用了!它应该看起来像下面这样:

<VirtualHost *:80>
    ServerName zfapp.localhost
    DocumentRoot /path/to/zfapp/public
    <Directory /path/to/zfapp/public>
        DirectoryIndex index.php
        AllowOverride All
        Order allow,deny
        Allow from all
        <IfModule mod_authz_core.c>
        Require all granted
        </IfModule>
    </Directory>
</VirtualHost>

Nginx 配置

要配置 Nginx,打开您的 /path/to/nginx/nginx.conf,并在 http 块中添加一个 include 指令(如果尚未存在)。

http {
    # ...
    include sites-enabled/*.conf;
}

/path/to/nginx/sites-enabled/zfapp.localhost.conf 下为您的项目创建一个虚拟主机配置文件,它应该看起来像下面这样:

server {
    listen       80;
    server_name  zfapp.localhost;
    root         /path/to/zfapp/public;

    location / {
        index index.php;
        try_files $uri $uri/ @php;
    }

    location @php {
        # Pass the PHP requests to FastCGI server (php-fpm) on 127.0.0.1:9000
        fastcgi_pass   127.0.0.1:9000;
        fastcgi_param  SCRIPT_FILENAME /path/to/zfapp/public/index.php;
        include fastcgi_params;
    }
}

重新启动 Nginx,现在您应该可以开始使用了!

QA 工具

该骨架默认不包含任何 QA 工具,但它为每个工具提供了配置。

此外,它还为提供的 Application\Controller\IndexController 包含了一些基本测试。

如果您想添加这些 QA 工具,请执行以下操作:

$ composer require --dev phpunit/phpunit squizlabs/php_codesniffer zendframework/zend-test

我们在 Composer 配置中为每个这些工具提供了别名。

# Run CS checks:
$ composer cs-check
# Fix CS errors:
$ composer cs-fix
# Run PHPUnit tests:
$ composer test