Modules : Routing

You can define your own routing rules for your Module. Routing definition uses XML files

Default Behaviour

All you have to do is to create a file named routing.xml in your Config directory. Thelia will configure a new router (with id router.module_code (ex : router.hooksearch)) and set a default priority (150) to it.

Custom Routing

If you need a custom configuration for your routing, you can declare a new service and tag this service and put router.register for the name property and the priority you want. Doing this, your file SHOULD NOT be named routing.xml (due to the default behaviour).

You SHOULD set the service ID with a unique identifier, and define the path to your routing file in the second element

The service ID, obviously, must be unique and a good practice is to prefix it with router : router.something

The second argument is the relative path to your routing file from the modules directory. The example below comes from the Front module and the priority level is set to 128 (so lower than the default priority).

<!-- the service id must be unique and prefixed by router. -->
<service id="router.front" class="%router.class%">
    <argument type="service" id="router.module.xmlLoader"/>
    
    <!-- This argument is the relative path to your routing file from the modules directory. Change it with your own path -->
    <argument>Front/Config/front.xml</argument>
    <argument type="collection">
        <argument key="cache_dir">%kernel.cache_dir%</argument>
        <argument key="debug">%kernel.debug%</argument>
    </argument>
    <argument type="service" id="request.context"/>
    <tag name="router.register" priority="128"/>
</service>

routes syntax

The routing.xml file contains something like this :

<?xml version="1.0" encoding="UTF-8" ?>

<routes xmlns="http://symfony.com/schema/routing"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="MyModule.home" path="/mymodule/" >
        <default key="_controller">Thelia\Controller\Front\DefaultController::noAction</default>
        <default key="_view">index</default>
    </route>
    
    <route id="MyModule.foo" path="/mymodule/foo" >
        <default key="_controller">Thelia:Front\Default:no</default>
        <default key="_view">foo</default>
    </route>

    <route id="MyModule.create.something" path="/mymodule/something/create">
        <default key="_controller">MyModule\Controller\SomethingController::createAction</default>
    </route>
    
    <route id="MyModule.update.something" path="/mymodule/something/update">
        <default key="_controller">MyModule:Something:update</default> 
        <!-- It is the same as:
        <default key="_controller">MyModule\Controller\SomethingController::updateAction</default> 
        -->
    </route>

</routes>

How to create a controller

A controller is basically a class. This class must extends a class, this class can differ according to its context.

If you are in FrontOffice context you must extend the Thelia\Controller\Front\BaseFrontController class. On the contrary in Admin context you must extend the Thelia\Controller\Admin\BaseAdminController

Example :

<?php
namespace MyModule\Controller;

use Thelia\Controller\Front\BaseFrontController;

class Something extends BaseFrontController
{
    public function createAction()
    {
        //my code here, you can access to many helpers here, see the api
    }
}

If you want to generate URL from route id in controllers, keep attention to use the right router. For example, if you want to use the generateRedirectFromRoute with a route defined in your module, you should set the current router properly :

<?php

class Something extends BaseFrontController
{
    protected $currentRouter = "router.mymodule";
    
    public function redirectAction()
    {
        return $this->generateRedirectFromRoute('mymodule.create.success');
    }
}