Routing

FloCMS routes pages by convention: the URL names the controller and the action, so most pages need no route definitions at all.

How a URL is read#

/{language}/{area}/{controller}/{action}/{parameters...}

Every part is optional. Some examples:

• Language. A first segment listed in LANGUAGES sets the language. Without it, DEFAULT_LANG is used. See localization.
• Area. A segment named in the routes setting picks the area and its method prefix (see below).
• Controller. Defaults to pages. Hyphens separate words: blog-post runs BlogPostController, and its views live in views/blog-post/, the folder php flo make:route BlogPost creates. blog_post reaches the same controller but looks for views in views/blog_post/, so pick one form and link to it consistently. Hyphenated controller URLs need flocms-core 2.2.2 or newer.
• Action. Defaults to index. Action names use letters, digits and _. Leading, trailing or double hyphens in a controller name, and anything else outside those characters, answer 404.
• Parameters. Everything after the action, decoded, in $this->params.

Areas and method prefixes#

config/config.php maps each area to a method prefix:

$routes = array(
    'default' => '',
    'admin'   => 'admin_',
);

Under /admin, FloCMS calls admin_ methods and uses the admin layout, and only signed-in users with admin access get in. So one controller serves both the site and its admin pages:

class BlogController extends Controller
{
    public function index(): void { /* /blog */ }

    public function admin_index(): void { /* /admin/blog */ }
}

Each area uses the layout of the same name, templates/<template>/layouts/<area>.html. The skeleton also registers a login area with the login_ prefix; a template needs a layouts/login.html file before that area can be used.

Parameters#

Parameters arrive as strings, in order:

// /blog/show/5/comments
public function show(): void
{
    [$id, $tab] = $this->params + [null, 'details'];
    // $id === '5', $tab === 'comments'
}

Parameters come straight from the URL. Validate them before using them in a query or a file path.

Which methods are reachable#

Only public, non-static methods declared on your controller, or on your own base controller, can be called from a URL. Inherited Controller methods, protected and private methods, and names starting with __ answer 404. Keep helper methods protected or private.

Redirects#

use FloCMS\Core\Router;

Router::redirect(SITE_URI . '/blog');

redirect() sends a 302 and stops the request.

API routes#

JSON endpoints don't use the convention routing. They are declared explicitly in api/routes.php and served under /api/v1. See building an API.

Routes supplied by modules#

Modules need explicit bootstrap and route loading. Declaring a namespaced page controller in a manifest does not change the conventional controller namespace or create its URL. Module-owned page actions need an availability check; API routes can use the kernel's module manager. See module page requests and module API routes.

Listing routes#

php flo route:list

shows every convention route of controllers/, with the permission each admin action needs, and the /api/v1 routes in one table.