README

用于 Slim 4.x 的注解路由器

安装

建议使用 Composer 来安装 Slim 注解路由器。

$ composer require "nicc0/slim-annotation-router"

这将安装 Slim 注解路由器和所有必要的依赖。请记住，Slim 4.x 需要 PHP 7.1 或更高版本。

用法

$factory = new DecoratedResponseFactory( new ResponseFactory(), new StreamFactory() );
$resolver = new CallableResolver();

$controllerPath = './app/controllers/';

$collector = new AnnotationRouteCollector( $factory, $resolver, $container );
$collector->setDefaultControllersPath( $controllersPath );
$collector->collectRoutes();

$app = new App( $factory, $container, $resolver, $collector );

通过注解创建路由

/**
 * Class ExampleController
 *
 * @RoutePrefix("/example")
 */
class ExampleController
{
    /**
     * @Route("/hello", methods={"GET"}, name="example.hello")
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function hello(): ResponseInterface
    {
        $response = new Response();
        $response->getBody()->write('Hello world!');

        return $response;
    }
}

通过访问 http://your_site_url/example/hello 的 URL，你应该能看到 "Hello world!"。

通过注解向控制器添加中间件

要向控制器或动作添加中间件，请使用 @Middleware("") 注解，该注解传递中间件名称。重要的是要知道我们传递的名称必须在容器中定义。名称作为 AnnotationRouteCollector 构造函数的第三个参数传递。同样重要的是，添加的中间件必须实现 MiddlewareInterface，否则中间件将不会添加到路由。

还可以向控制器或动作添加多个中间件。

例如，我们需要向控制器添加 AuthMiddleware。首先，我们必须在容器中定义 AuthMiddleware。

$container->set('authMiddleware', function() use ($container) {
    return new AuthContainer(container);
})

如果中间件存在于我们的容器中，现在我们可以通过在控制器中添加 @Middleware("authMiddleware") 来使用中间件注解。

/**
 * @RoutePrefix("/example")
 * @Middleware("authMiddleware")
 */
class ExampleController
{
    /**
     * @Route("/hello", methods={"GET"}, name="example.hello")
     */
    public function hello(): ResponseInterface
    {
        ...
    }
}

测试

要执行测试套件，您需要安装所有开发依赖项。

git clone https://github.com/Nicc0/Slim-Annotation-Router
composer install
composer test

许可证

Slim 注解路由器采用 MIT 许可证。有关更多信息，请参阅 许可证文件。