aura/framework-project

由 Aura v2 包构建的精简型 web+cli 框架

2.0.1 2015-03-28 21:45 UTC

This package is auto-updated.

Last update: 2024-09-11 03:47:48 UTC


README

此包提供了一种用于联合 web 和命令行项目的最小框架。

“最小”意味着非常小。该包仅提供依赖注入容器、配置系统、web 路由和调度器、CLI 调度器、一对 web 请求和响应对象、一对 CLI 上下文和标准输入/输出对象,以及一个日志实例。

这种最小实现不应被视为“受限”。DI 容器具有双阶段配置系统,允许广泛的程序性服务定义。路由器和调度器是考虑迭代重构而构建的,因此您可以从类似微框架的闭包开始,逐步过渡到您自己设计的更复杂的控制器和命令对象。

前言

要求

此项目需要 PHP 5.4 或更高版本;我们原则上建议使用可用的最新 PHP 版本。

与 Aura 库包不同,此项目包具有用户空间依赖,这些依赖本身可能还有其他依赖

安装

通过 Composer 将此项目安装到您选择的 {$PROJECT_PATH}

composer create-project aura/framework-project {$PROJECT_PATH}

这将创建项目骨架并安装所有必要的包。

测试

Build Status

要运行命令行中的单元测试,请在包根目录中运行 ./phpunit.sh。这需要 PHPUnit 作为 phpunit 可用。

或者,在您安装了项目之后,尝试“hello world”CLI 和 web 应用程序。

对于 CLI,转到项目目录并运行以下命令

cd {$PROJECT_PATH}
php cli/console.php hello

您应该看到输出 Hello World!。尝试在 hello 后面传递一个名字,以查看 Hello name!

对于 web,使用 web/ 目录作为文档根启动内置的 PHP 服务器

cd {$PROJECT_PATH}
php -S localhost:8000 -t web/

当您浏览到 http://localhost:8000 时,您应该看到输出为 "Hello World!"。此后终止内置服务器进程。(请务必仅将内置 PHP 服务器用于测试,绝不要用于生产。)

PSR 合规性

此项目试图遵守 PSR-1PSR-2PSR-4。如果您注意到合规性疏忽,请通过拉取请求发送补丁。

社区

要提问、提供反馈或与其他 Aura 社区交流,请加入我们的 Google Group、关注 @auraphp on Twitter 或在 Freenode 上的 #auraphp 上与我们聊天。

服务

此包使用以下定义的服务

此项目重置以下服务

  • logger:一个 Monolog\Logger 实例

入门指南

此框架项目包仅是 CLI 和 web 项目包的组合。请参阅它们各自的“入门指南”