Registering Routes

So far we've seen how to create route definitions and controller classes. However, there one last step required for our routes to be enabled inside our application. That is registering the route class inside the Sprinkle Recipe.

The first step is to create a new class that will return the Slim route definition. This class must implement the UserFrosting\Routes\RouteDefinitionInterface interface from the UserFrosting Framework. For example :

app/src/MyRoutes.php

<?php

namespace UserFrosting\App;

use Slim\App;
use UserFrosting\App\Controller\AppController;
use UserFrosting\Routes\RouteDefinitionInterface;

class MyRoutes implements RouteDefinitionInterface
{
    public function register(App $app): void
    {
        $app->get('/owls', [AppController::class, 'pageOwls'])->setName('page.owls');
    }
}

Note in the previous example how the class has a FQN of \UserFrosting\App\MyRoutes.

To register this class inside your application, you need to add it to the getRoutes() method of the Sprinkle Recipe. Don't forget to add the previous class to the use block at the top. For example :

app/src/MyApp.php

<?php

namespace UserFrosting\App;

// ...
use UserFrosting\Sprinkle\SprinkleRecipe;
use UserFrosting\App\MyRoutes; // <-- Add here !
// ...

class MyApp implements SprinkleRecipe {

    // ... 

    /**
     * Returns a list of routes definition in PHP files.
     *
     * @return string[]
     */
    public function getRoutes(): array
    {
        return [
            MyRoutes::class, // <-- Add here !
        ];
    }
}

The route definitions defined in MyRoutes will now be served by UserFrosting!

Overriding Routes

Routes themselves cannot be extended by other Sprinkles and they cannot be overridden. To modify the behavior of one of the routes that ships with UserFrosting, you may simply redefine it in one of your route classes. However, you cannot register two routes with the same path, otherwise the following error will be thrown:

Cannot register two routes matching "/" for method "GET"

To solve this, it's possible to manually customize a dependent Sprinkle Recipe. Check out the Advanced Dev Features chapter for more info on this technique.

Another workaround is to override the Action class called in the dependent Sprinkle's route.