You are here

Home » API reference » Examples for Developers 3.x

menu_example.routing.yml in Examples for Developers 3.x

modules/menu_example/menu_example.routing.yml
8 string references to YAML keys in menu_example.routing.yml
MenuExampleController::customAccess in modules/menu_example/src/Controller/MenuExampleController.php
Demonstrates the use of custom access check in routes.
MenuExampleController::permissioned in modules/menu_example/src/Controller/MenuExampleController.php
A menu entry with simple permissions using 'access protected menu example'.
MenuExampleController::placeholderArgs in modules/menu_example/src/Controller/MenuExampleController.php
Demonstrates how you can provide a placeholder url arguments.
MenuExampleController::routeOnly in modules/menu_example/src/Controller/MenuExampleController.php
Give the user a link to the route-only page.
MenuExampleController::urlArgument in modules/menu_example/src/Controller/MenuExampleController.php
Demonstrates use of optional URL arguments in for menu item.

... See full list

File

modules/menu_example/menu_example.routing.yml
View source 
  1. # This file contains routing entries which is then read by Drupal to match

  2. # a particular request which a corresponding path.  A particular route entry

  3. # is bound to the URI defined using 'path' key, the 'access content' permission

  4. # is checked on the accessing user and, if access is granted, the

  5. # MenuExampleController::{methodName} method is invoked and a page is displayed

  6. # with defined response.

  7. # '_controller' defines the controller class and it's method which Drupal's

  8. # autoload mechanism looks for, creating the response from.

  9. #

  10. examples.menu_example: # This is a route name.

  11.   path: '/examples/menu-example'

  12.   defaults:

  13.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::description'

  14.     _title: 'Menu Example'

  15.   requirements:

  16.     _permission: 'access content'

  17. 

  18. # This menu entry will appear as main menu tab instead of tools menu.

  19. # In menu_example.links.menu.yml we have used 'menu_name' as 'main' which links

  20. # the menu entry to main navigation menu.

  21. examples.menu_example.alternate_menu:

  22.   path: '/examples/menu-example-alternate-menu'

  23.   defaults:

  24.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::alternateMenu'

  25.     _title: 'Menu Example: Menu in alternate menu'

  26.   requirements:

  27.     _permission: 'access content'

  28. 

  29. # The menu entry demonstrates the use of permissions to restrict access

  30. # to a particular path until and unless the requirement is met.

  31. examples.menu_example.permissioned:

  32.   path: '/examples/menu-example/permissioned'

  33.   defaults:

  34.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::permissioned'

  35.     _title: 'Permissioned Route Example'

  36.   requirements:

  37.     _permission: 'access content'

  38. 

  39. # Only the user with the required permission will be able to access this route.

  40. examples.menu_example.permissioned_controlled:

  41.   path: '/examples/menu-example/permissioned/controlled'

  42.   defaults:

  43.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::permissionedControlled'

  44.     _title: 'Permissioned Route'

  45.   requirements:

  46.     _permission: 'access protected menu example'

  47. 

  48. # Sometimes just relying on permissions and/or roles is not sufficient

  49. # and you need to do custom access checking on routes.

  50. examples.menu_example.custom_access:

  51.   path: '/examples/menu-example/custom-access'

  52.   defaults:

  53.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::customAccess'

  54.     _title: 'Custom Access Example'

  55.   requirements:

  56.     _permission: 'access content'

  57. 

  58. # Custom access is called once this route is requested.

  59. # Check src/Access/RoleAccessCheck.php

  60. examples.menu_example.custom_access_page:

  61.   path: '/examples/menu-example/custom-access/page'

  62.   defaults:

  63.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::customAccessPage'

  64.     _title: 'Custom Access Menu Item'

  65.   requirements:

  66.     _menu_example_role: 'TRUE'

  67. 

  68. # This route has a corresponding menu entry, so the user can click on it in the

  69. # UI. This gives them a link to a route with no menu entry.

  70. examples.menu_example.route_only:

  71.   path: '/examples/menu-example/route-only'

  72.   defaults:

  73.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::routeOnly'

  74.     _title: 'Route only example'

  75.   requirements:

  76.     _permission: 'access content'

  77. 

  78. # These type of routes can be used to create webservices.

  79. examples.menu_example.route_only.callback:

  80.   path: '/examples/menu-example/route-only/callback'

  81.   defaults:

  82.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::routeOnlyCallback'

  83.     _title: 'Callback only'

  84.   requirements:

  85.     _permission: 'access content'

  86. 

  87. # Drupal 8's routes may include placeholder elements which designate places

  88. # where the URL contains dynamic values. In the controller method, this value

  89. # is available when a variable with the same name is used in the controller

  90. # method. Matching the variable name is must. The {arg} element in the URL is

  91. # called a slug and is available as a $arg in the controller method.

  92. examples.menu_example.use_url_arguments:

  93.   path: '/examples/menu-example/use-url-arguments/{arg1}/{arg2}'

  94.   defaults:

  95.     _title: 'URL Arguments'

  96.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::urlArgument'

  97.     # We provide default value to both arguments.

  98.     arg1: ''

  99.     arg2: ''

  100.   requirements:

  101.     _permission: 'access content'

  102. 

  103. # Title of this menu entry will be altered by controller method defined by

  104. # key '_title_callback'.

  105. examples.menu_example.title_callbacks:

  106.   path: '/examples/menu-example/title-callbacks'

  107.   defaults:

  108.     _title_callback: 'Drupal\menu_example\Controller\MenuExampleController::titleCallback'

  109.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::titleCallbackContent'

  110.   requirements:

  111.     _permission: 'access content'

  112. 

  113. # A menu item entry to demonstrate use of parameters in routes.

  114. examples.menu_example.placeholder_argument:

  115.   path: '/examples/menu-example/placeholder-argument'

  116.   defaults:

  117.     _title: 'Placeholder Arguments'

  118.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::placeholderArgs'

  119.   requirements:

  120.     _permission: 'access content'

  121. 

  122. # Parameters in routes can be used as placeholders arguments too.

  123. examples.menu_example.placeholder_argument.display:

  124.   path: '/examples/menu-example/placeholder-argument/{arg}/display'

  125.   defaults:

  126.     _title: 'Placeholder Arguments'

  127.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::placeholderArgsDisplay'

  128.   requirements:

  129.     arg: \d+

  130.     _permission: 'access content'

  131. 

  132. # Any route defined here can be altered. We can do so by defining a RouteSubscriber!

  133. example.menu_example.path_override:

  134.   path: '/examples/menu-example/menu-original-path'

  135.   defaults:

  136.     _title: 'Menu path that will be altered'

  137.     _controller: '\Drupal\menu_example\Controller\MenuExampleController::pathOverride'

  138.   requirements:

  139.     _permission: 'access content'

  140. 

  141. # Dynamic routes are implemented in a method. This method is added as a

  142. # 'route_callbacks'

  143. route_callbacks:

  144.   - '\Drupal\menu_example\Routing\MenuExampleDynamicRoutes::routes'