Graze\Silex\ControllerProvider\TrailingSlashControllerProvider

Complexity

Total Complexity

4

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	12	2
A	connect()	0	43	2

<?php

namespace Graze\Silex\ControllerProvider;

use Pimple\Container;
use Pimple\ServiceProviderInterface;
use Silex\Application;
use Silex\Api\ControllerProviderInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\Routing\Matcher\UrlMatcher;

/**
 * A controller provider to convert requests missing a trailing slash into an
 * internal sub-request with a slash appended to the requests url.
 *
 * NOTE: You _should_ define all other routes with a trailing slash.
 *
 * Usage:
 *
 * ```
 * $provider = new \Graze\Silex\ControllerProvider\TrailingSlashControllerProvider();
 * $app->register($provider);
 * $app->mount('/', $provider);
 * ```
 */
final class TrailingSlashControllerProvider implements ControllerProviderInterface, ServiceProviderInterface
{
    /**
     * @param Application $app
     *
     * @return \Silex\ControllerCollection
     */
    public function connect(Application $app)
    {
        $controllers = $app['controllers_factory'];

        $handler = function ($resource) use ($app) {
            if ($app['logger']) {
                $app['logger']->debug(sprintf('Appending a trailing slash for the request to `/%s`.', $resource));
            }

            $currentRequest = $app['request_stack']->getCurrentRequest();
            $request = Request::create(
                '/' . $resource . '/',
                $currentRequest->getMethod(),
                [],
                $currentRequest->cookies->all(),
                $currentRequest->files->all(),
                $currentRequest->server->all(),
                $currentRequest->getContent()
            );
            $request = $request->duplicate(
                $currentRequest->query->all(),
                $currentRequest->request->all()
            );
            $request->headers->replace($currentRequest->headers->all());

            // Make an internal sub-request based off the request that would have 404'd.
            // http://silex.sensiolabs.org/doc/usage.html#forwards
            return $app->handle($request, HttpKernelInterface::SUB_REQUEST);
        };

        /**
         * Register the catch-all route.
         *
         * Use a look behind assertion to ensure we only match routes
         * with no trailing slash.
         *
         * @link https://stackoverflow.com/questions/16398471/regex-not-ending-with
         */
        $controllers->match('/{resource}', $handler)
                    ->assert('resource', '.*(?<!\/)$')
                    ->bind('no_trailing_slash_handler');

        return $controllers;
    }

    /**
     * @param Container $app
     */
    public function register(Container $app)
    {
        /**
         * We override the default RedirectableUrlMatcher so that Silex doesn't
         * respond with 301 to GET requests missing a trailing slash.
         */
        $app['request_matcher'] = function (Container $app) {
            if ($app['logger']) {
                $app['logger']->debug(sprintf('Overriding the default Silex url matcher to %s.', UrlMatcher::class));
            }

            return new UrlMatcher($app['routes'], $app['request_context']);
        };
    }
}