Routing

Loading Routes

SiteSupra routing is heavily based on Symfony’s routing component and uses very similar syntax. However, there are some minor differences. For example, you have to load all your routing files manually in your package’s inject() method:

1
2
3
4
5
<?php

$container->getRouter()->loadConfiguration(
    $container->getApplication()->locateConfigFile($this, 'routes.yml')
);

Function locateConfigFile searches routes.yml in your package’s Resources\config directory.

Common Example

Let’s take a look at some routing definition examples. The most simple would be SupraPackageFramework main routing file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
configuration:
    prefix:             ~
routes:
    framework_combo:
        pattern:        /_framework_internal/combo/{paths}
        controller:     Framework:Combo:combo
        requirements:
            paths:      .+
        defaults:
            paths:      ~
    framework_routes:
        pattern:        /_framework_internal/routes
        controller:     Framework:Routing:export

configuration section at line 1 defines global prefix and defaults (default parameter values) keys. prefix must be explicitly defined even with default ~ value.

routes section, starting from line 3, defines actual routes. Each route may contain the following fields:

  • pattern defines actual URI that will trigger the route;
  • controller specifies the controller (in the example above, Framework:Combo:combo resolves into SupraPackageFramework → ComboController → comboAction (just like Symfony does!);
  • filters defines Symfony route filters;
  • requirements here you can specify per-parameter regex requirements;
  • defaults provides default parameter values;
  • options at the moment supports frontend key only.

where only pattern and controller are required.

Tip

Due to the fact SiteSupra’s routing is based on Symfony Routing component, everything written in Symfony documentation applies to SiteSupra as well - we did not reinvent the wheel here.

Container Parameters and JavaScript

Let’s see a bit more complicated example from SupraPackageCms:

1
2
3
4
5
6
7
8
configuration:
    prefix: ~
routes:
    cms_dashboard:
        pattern:            %cms.prefix%
        controller:         Cms:Dashboard:index
        options:
            frontend:       true

First of all, you can use container parameters (in %container.parameter.name% form) in your route pattern. Secondly, you can provide frontend: true option and use in Javascript like this:

1
Supra.Url.generate('cms_dashboard');