Multiple instances? - Githubissues

Well, I had a project where there was a main site, and a mobile site in the same code base, with different endpoints (so the main site was example.com and the mobile site was example.com/mobile/. For the mobile one, we had a separate routes file, which had its own routes. There was a separate RewriteRule pointing /mobile/{anything} at /mobile/index.php which took precedence over the general rule, which pointed things to /index.php.

It worked, but I'm not sure I would do it that way again, especially if you're real goal is modular routes, rather than a single offshoot. If you want to have lots of routes in separate files, this might be a little ghetto, but it would work:

<?php
require_once __DIR__ . '/vendor/autoload.php';

$klein = new \Klein\Klein();

// You will have to define this function, based on the structure of your application.
// It's supposed to return an array of strings which are the file paths for the route files.
$route_file_paths = get_route_file_paths();

foreach($route_file_paths as $path) {
    include __DIR__.$path;
}
$klein->dispatch();

That would require that each route file you include be well-behaved, and that it would declare its routes using $klein to refer to the \Klein\Klein object.

<?php
$klein->respond('GET', '/whatever', function(){return "stuff";});

Depending on the project, you might be able to get away with that, but I already admitted it's ghetto.

The next step up would be to implement an API in your module architecture for requesting routes. So you would have something like this:

<?php
require_once __DIR__ . '/vendor/autoload.php';

$klein = new \Klein\Klein();

// You will have to define this function, based on the structure of your application.
// It's supposed to return an array of objects which somehow represent your modules, and implement the method getRoutes().
$my_modules = get_my_modules();

foreach($my_modules as $mod) {
    // You would have to implement getRoutes in each module
    // It's supposed to return an array of "route signatures", a concept I just made up
    // Each route signature would be an associative array with three keys: method, pattern, action (you could probably have guessed that
    // They would contain the parameters to be passed to the respond method, as shown below
    foreach($mod->getRoutes() as $route) {
        $klein->respond($route['method'], $route['pattern'], $route['action']);
    }
}
$klein->dispatch();

That's just off the top of my head. If you started to implement this, you'd probably come up with a better way to implement it, but it would do roughly the same thing.

If you look at what the Klein::respond method is doing, it's just adding routes to a collection in inside itself, $this->routes: https://github.com/klein/klein.php/blob/master/src/Klein/Klein.php#L343

So you could make things a little more elegant like this:

<?php
require_once __DIR__ . '/vendor/autoload.php';

$klein = new \Klein\Klein();

// You will have to define this function, based on the structure of your application.
// It's supposed to return an array of objects which somehow represent your modules, and implement the method getRoutes().
$my_modules = get_my_modules();

foreach($my_modules as $mod) {
    // You would have to implement getRoutes in each module, which return an array of routes
    // See: https://github.com/klein/klein.php/blob/master/src/Klein/Route.php
    // See also: https://github.com/klein/klein.php/blob/master/src/Klein/RouteFactory.php
    foreach($mod->getRoutes() as $route) {
        $klein->routes()->add($route);
    }
}
$klein->dispatch();

It's basically the same thing as the one before, except the getRoutes method in each module would define an array of routes, instead of an array of arrays of the parameters required to define routes, which seems a little cleaner to me. There are probably still a lot of ways to improve upon the example above, but I think you get the idea.

So if you do what I did in real life, you'd have multiple Klein instances, and extra htaccess stuff. On the other hand, if you follow the variations on a theme I just proposed, you'd keep a single instance of Klein, and avoid extra htaccess/modrewrite config, which I think is better part of valor.

klein / klein.php

Multiple instances? #392