nopoco/laminas-mvc-skeleton

Laminas MVC 框架应用程序骨架

v2.1.0 2023-05-02 11:23 UTC

This package is auto-updated.

Last update: 2024-08-31 00:41:36 UTC


README

在此处移除与自由软件不相容的政治呼吁。原始存储库在此 链接

简介

这是一个使用 Laminas MVC 层和模块系统的应用程序骨架。该应用程序旨在作为那些想要开始使用 Laminas MVC 的人的起点。

使用 Composer 进行安装

创建新的 Laminas MVC 项目的最简单方法是使用 Composer。如果您尚未安装,请按照 文档 进行安装。

创建新的 Laminas MVC 项目

$ composer create-project -sdev laminas/laminas-mvc-skeleton path/to/install

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

$ cd path/to/install
$ php -S 0.0.0.0:8080 -t public
# OR use the composer alias:
$ composer serve

这将在 8080 端口启动 cli-server,并将其绑定到所有网络接口。您可以在 http://localhost:8080/ 访问该站点

  • 它将显示 Laminas MVC 骨架欢迎页面。

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

开发模式

该骨架默认包含 laminas-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 测试支持。

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

    $ composer require --dev laminas/laminas-test

一旦测试支持可用,您可以使用以下方式运行测试

$ ./vendor/bin/phpunit

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

运行 Psalm 静态分析

要运行提供的骨架静态分析,您需要执行以下操作之一:建议安装来自 laminas(laminas/laminas-test)的测试组件,因为这在提供的测试中已使用。

$ composer require --dev vimeo/psalm psalm/plugin-phpunit laminas/laminas-test

一旦 psalm 支持可用,您可以使用以下方式运行静态分析

$ composer static-analysis

使用 docker-compose

此骨架为docker-compose提供了一个docker-compose.yml文件;它使用提供的Dockerfile来构建一个用于laminas容器的docker镜像。

使用以下命令构建并启动镜像和容器:

$ docker-compose up -d --build

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

您还可以在容器中运行如composer等命令。容器环境名为“laminas”,因此您需要将该值传递给docker-compose run

$ docker-compose run laminas composer install

一些Composer包可选地使用额外的PHP扩展。
Dockerfile中包含了一些注释掉的命令,这些命令启用了一些流行的PHP扩展。例如,为了为laminas/laminas-db安装pdo-pgsql支持,取消以下行的注释

# RUN apt-get install --yes libpq-dev \
#     && docker-php-ext-install pdo_pgsql

然后重新运行上面的docker-compose up -d --build命令。

您可能还希望在以后将各种apt-getdocker-php-ext-*语句组合起来,以减少镜像创建的层数。

Web服务器设置

Apache设置

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

<VirtualHost *:80>
    ServerName laminasapp.localhost
    DocumentRoot /path/to/laminasapp/public
    <Directory /path/to/laminasapp/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/laminasapp.localhost.conf下为您的项目创建一个虚拟主机配置文件,它应该看起来像下面这样

server {
    listen       80;
    server_name  laminasapp.localhost;
    root         /path/to/laminasapp/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/laminasapp/public/index.php;
        include fastcgi_params;
    }
}

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

QA工具

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

此外,它还提供了一些针对 shipped Application\Controller\IndexController的基本测试。

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

$ composer require --dev squizlabs/php_codesniffer laminas/laminas-test

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

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