Configuration Reference

routers_by_id

prototype: array default: { router.default: 100 }

This defines the routers to use in the chain. By default, only the Symfony router is used. The key is the name of the service and the value is the priority. The chain is sorted from the highest to the lowest priority.

To add the DynamicRouter, use the following configuration:

1
2
3
4
5
6

# app/config/packages/cmf_routing.yaml
cmf_routing:
    chain:
        routers_by_id:
            cmf_routing.dynamic_router: 200
            router.default:             100

1
2
3
4
5
6
7
8
9
10
11
12

<!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services">

    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <chain>
            <router-by-id id="cmf_routing.dynamic_router">200</router-by-id>
            <router-by-id id="router.default">100</router-by-id>
        </chain>
    </config>

</container>

1
2
3
4
5
6
7
8
9

// app/config/packages/cmf_routing.php
$container->loadFromExtension('cmf_routing', [
    'chain' => [
        'routers_by_id' => [
            'cmf_routing.dynamic_router' => 200,
            'router.default'             => 100,
        ],
    ],
]);

replace_symfony_router

type: Boolean default: true

If this option is set to false, the default Symfony router will not be overridden by the ChainRouter. By default, the ChainRouter will override the default Symfony router, but it will pass all requests to the default router, because no other routers were set.

1
2
3
4

# app/config/packages/cmf_routing.yaml
cmf_routing:
    chain:
        replace_symfony_router: true

1
2
3
4
5
6
7
8
9
10
11

<!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services">

    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <cmf-routing>
            <chain replace-symfony-router="true"/>
        </cmf-routing>
    </config>

</container>

1
2
3
4
5
6

// app/config/packages/cmf_routing.php
$container->loadFromExtension('cmf_routing', [
    'chain' => [
        'replace_symfony_router' => true,
    ],
]);

enabled

type: Boolean default: false

Use this setting to activate the DynamicRouter. This will create a cmf_routing.dynamic_router service which you can add to the chain.

generic_controller

type: string default: null

This configuration specifies the controller that is used when the route enhancers define a template but no explicit controller. It accepts any valid Symfony controller reference.

If the CoreBundle and ContentBundle (no longer maintained) are registered, this defaults to cmf_content.controller::indexAction.

default_controller

type: string default: value of generic_controller

The default controller to use if none of the enhancers found a controller. Accepts any valid Symfony controller reference.

controllers_by_type

prototype: array

If the matching route has a type value in its defaults and no explicit controller is set, the route is handled by the controller configured for that type:

1
2
3
4
5

# app/config/packages/cmf_routing.yaml
cmf_routing:
    dynamic:
        controllers_by_type:
            editable:   AppBundle:Cms:editable

1
2
3
4
5
6
7
8
9
10
11

<!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services">

    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <dynamic>
            <controller-by-type type="editable">AppBundle:Cms:editable</controller-by-type>
        </dynamic>
    </config>

</container>

1
2
3
4
5
6
7
8

// app/config/packages/cmf_routing.php
$container->loadFromExtension('cmf_routing', [
    'dynamic' => [
        'controllers_by_type' => [
            'editable' => 'AppBundle:Cms:editable',
        ],
    ],
]);

controllers_by_class

prototype: array

The controller to use when the matching route implements RouteObjectInterface and returns an object for getRouteContent(). This object is checked for being instanceof the class names in this map. instanceof is used instead of direct comparison to work with proxy classes and other extending classes. The order in which the classes are specified, matters. The first match is taken.

If matched, the controller will be set as _controller, making Symfony choose this controller to handle the request.

1
2
3
4
5

# app/config/packages/cmf_routing.yaml
cmf_routing:
    dynamic:
        controllers_by_class:
            Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent: cmf_content.controller::indexAction

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services">

    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <dynamic>
            <controller-by-class
                class="Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent">
                cmf_content.controller::indexAction
            </controller-by-class>
        </dynamic>
    </config>

</container>

1
2
3
4
5
6
7
8
9
10

// app/config/packages/cmf_routing.php
use Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent;

$container->loadFromExtension('cmf_routing', [
    'dynamic' => [
        'controllers_by_class' => [
            StaticContent::class => 'cmf_content.controller::indexAction',
        ),
    ),
));

template_by_class

prototype: array

The template to use when the route implements RouteObjectInterface and returns an object for getRouteContent(). This object is checked for being instanceof the class names in this map. instanceof is used instead of direct comparison to work with proxy classes and other extending classes. The order in which the classes are specified, matters. The first match is taken.

If matched, the template will be set as _template in the defaults and unless another mapping specifies a controller, the generic_controller setting is set as controller.

1
2
3
4
5

# app/config/packages/cmf_routing.yaml
cmf_routing:
    dynamic:
        templates_by_class:
            Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent: CmfContentBundle:StaticContent:index.html.twig

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services">
    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <dynamic>
            <template-by-class
                class="Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent">
                CmfContentBundle:StaticContent:index.html.twig
            </template-by-class>
        </dynamic>
    </config>

</container>

1
2
3
4
5
6
7
8
9
10

// app/config/packages/cmf_routing.php
use Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent;

$container->loadFromExtension('cmf_routing', [
    'dynamic' => [
        'templates_by_class' => [
            StaticContent::class => 'CmfContentBundle:StaticContent:index.html.twig',
        ),
    ),
));

route_collection_limit

type: scalar, default: 0

If this value is set to a number bigger than 0, the getRouteCollection() method returns a collection of routes read from the database. The limit serves to prevent huge route lists if you have a large database. Setting the limit to false disables the limit entirely and attempts to return all routes.

persistence

1
2
3
4
5
6
7
8
9
10
11

# app/config/packages/cmf_routing.yaml
cmf_routing:
    dynamic:
        persistence:
            phpcr:
                enabled:      false
                manager_name: ~
                route_basepaths:
                    - /cms/routes
                    - /cms/simple
                enable_initializer: true

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<!-- app/config/packages/cmf_routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services">
    <config xmlns="http://cmf.symfony.com/schema/dic/routing">
        <dynamic>
            <persistence>
                <phpcr
                    enabled="false"
                    manager-name="null"
                    enable_initializer="true"
                >
                    <route-basepath>/cms/routes</route-basepath>
                    <route-basepath>/cms/simple</route-basepath>
                </phpcr>
            </persistence>
        </dynamic>
    </config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

// app/config/packages/cmf_routing.php
$container->loadFromExtension('cmf_routing', [
    'dynamic' => [
        'persistence' => [
            'phpcr' => [
                'enabled'            => false,
                'manager_name'       => null,
                'route_basepaths'    => [
                    '/cms/routes',
                    '/cms/simple',
                ],
                'enable_initializer' => true,
            ],
        ],
    ],
]);

1
2
3
4
5
6

phpcr: ~ # use default configuration
# or
phpcr: true # straight way
# or
phpcr:
    manager: ... # or any other option under 'phpcr'

1
2
3
4
5
6
7
8
9
10

<persistence>
    <!-- use default configuration -->
    <phpcr />

    <!-- or setting it the straight way -->
    <phpcr>true</phpcr>

    <!-- or setting an option under 'phpcr' -->
    <phpcr manager="..." />
</persistence>

1
2
3
4
5
6
7
8
9
10
11
12

$container->loadFromExtension(..., array( // bundle configuration key, e.g. cmf_menu
    // ...
    'persistence' => array(
        'phpcr' => null, // use default configuration
        // or
        'phpcr' => true, // straight way
        // or
        'phpcr' => array(
            'manager' => '...', // or any other option under 'phpcr'
        ),
    ),
));