Classes for entries in the routing table may implement this interface in addition to extending Symfony\Component\Routing\Route.
If they do, the DynamicRouter will request the route content and put it into the RouteObjectInterface::CONTENT_OBJECT field. The DynamicRouter will also request getRouteKey and this will be used instead of the symfony core compatible route name and can contain any characters.
Some fields in defaults have a special meaning in the getDefaults(). In addition to the constants defined in this class, _locale and _controller are also used.
Expanded class hierarchy of RouteObjectInterface
All classes that implement RouteObjectInterface
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
RouteObjectInterface:: |
constant | Field name for the content of the current route, if any. | ||
RouteObjectInterface:: |
constant | Field name for an explicit controller name to be used with this route | ||
RouteObjectInterface:: |
public | function | Get the content document this route entry stands for. If non-null, the ControllerClassMapper uses it to identify a controller and the content is passed to the controller. | 2 |
RouteObjectInterface:: |
public | function | Get the route key. | 3 |
RouteObjectInterface:: |
constant | Field name that will hold the route name that was matched. | ||
RouteObjectInterface:: |
constant | Field name of the route object that was matched. | ||
RouteObjectInterface:: |
constant | Field name for an explicit template to be used with this route. i.e. CmfContentBundle:StaticContent:index.html.twig |