stack/url-map

URL Map middleware.

v1.2.0 2019-06-20 08:03 UTC

Requires

• php: ^7.1
• symfony/http-foundation: ~2.1|~3.0|~4.0
• symfony/http-kernel: ~2.1|~3.0|~4.0

Requires (Dev)

• phpunit/phpunit: ~7.0
• silex/silex: ^2.0
• stack/builder: ^1.0
• stack/callable-http-kernel: ^1.0

MIT

• Christoph Hochstrasser

README

The UrlMap class takes an array mapping paths to apps and dispatches accordingly. This class is insertable into a Middleware Stack Builder, like stack/builder.

Install

Install with Composer:

$ composer require stack/url-map

Example

Let's say we have a Silex app and want to map a blogging app which implements HttpKernelInterface at the sub path /blog:

<?php

use Symfony\Component\HttpFoundation\Request;
use Silex\Application;

$app = new Application();
$app->get('/', function () {
    return "Main Application!";
});

$blog = new Application();
$blog->get('/', function () {
    return "This is the blog!";
});

$map = [
    "/blog" => $blog
];

$app = (new Stack\Builder())
    ->push('Stack\UrlMap', $map)
    ->resolve($app);

$request = Request::createFromGlobals();

$response = $app->handle($request);
$response->send();

$app->terminate($request, $response);

If you now navigate to /blog you should see This is the blog! in your browser.

The UrlMap overrides SCRIPT_NAME, SCRIPT_FILENAME and PHP_SELF to point at the mapped path. This also makes sure that the path is stripped from the path info.

This also means that apps which use the Symfony Routing component for Routing and URL Generation don't need any adaptions.

Apps using other means for routing should prepend the return value of the request's getBaseUrl() method to generated URLs. The URL Map also sets a stack.url_map.prefix request attribute, which can be used if you don't want to rely on the request base URL.