Routing and URL rewriting

From URL to controller

Route::parseURI() splits the URL without any route declarations:

1. It lower-cases everything and replaces - with _ (/reset-password → reset_password).
2. If the first segment is admin and there are more segments, it removes it and marks the route as an admin one (looked up in Controllers/Admin/).
3. If the next segment is the name of an active plugin, it removes it and looks for controllers in plugins/<plugin>/src/Controllers/.
4. While the segments match sub-folders of Controllers/, they are consumed as folders.
5. What is left is controller/action/arguments….

Arguments are passed to the action as parameters, in order:

public function ver($id = null, $color = null) {
    $producto = TMProductos::find(intval($id));
    if (!$producto) {
        $this->Response->setCode(404);
        return;
    }
    $this->set(['producto' => $producto]);
}

Special parameters

• ?action=name in the query string (or the POST data) replaces the URL's action.
• ?subaction=name is available in Route::get()['subaction'].

Reading the current route

$route = Route::get();
// ['uri'=>'productos/ver/15', 'qs'=>'', 'plugin'=>'', 'controller'=>'Productos',
//  'action'=>'ver', 'raw_action'=>'ver', 'arguments'=>['15']]

Route::getDomain();     // 'https://mysite.com'
Route::setAction('other');

Plugin static files

If the URL starts with a plugin name and ends in .js, .css, .map or an image extension, Koshkil serves the file straight from plugins/<plugin>/webroot/. A .js URL that is not a real file is treated as the controller's javascript action, which is handy for generating JavaScript from PHP.

Rewrite rules

For URLs that don't follow the convention, define rules in config/rewrite.php (or the domain's) under System.Web.Rewrite. They are evaluated before routing, in order, against the URL without its leading slash.

<?php
$CONFIG = [
    'System' => [
        'Web' => [
            'Rewrite' => [
                // /negocios/lopez-bakery  ->  /negocios?nombre=lopez-bakery
                ['rule' => '^negocios/([a-z\-0-9]*)$', 'target' => '/negocios?nombre=$1', 'flags' => 'L,NC'],
                // alias for an admin section
                ['rule' => '^admin/usuarios/(editar|listado)$', 'target' => '/admin/sistema/usuarios/$1?subusuarios=1', 'flags' => 'L,NC'],
            ],
        ],
    ],
];

Rules can also be added from code, before routing:

RewriteManager::addRule('^ofertas$', '/productos/listado?oferta=1', 'L,NC');
RewriteManager::addRule('^promo$', '/productos/promo', 'L', true); // true: at the top

Plugins declare their rules in plugins/<plugin>/config/rewrite.php (a $RULES array), added after the global ones. With Debug.Rewrite at 5 or more, every evaluation is logged to tmp/logs/rewrite.log.

Building links

Never hard-code absolute paths: the project may live in a sub-folder.

<a href="{Koshkil::getLink('/productos/ver/'|cat:$producto->prd_codigo)}">View</a>
<link rel="stylesheet" href="{Koshkil::getThemePath('css/theme.css')}">