Drupal 8 in action, the route to the method

Goodbye to hook_menu() for routing
and for everything else...

Routing	Routes defined in routing.yml and controllers
Menu links	Defined in hook_default_menu_links()
Local actions	Plugins defined in local_actions.yml
Local tasks	Plugins defined in local_tasks.yml
Contextual links	Plugins defined in contextual_links.yml
Breadcrumbs	Implementing BreadcrumbBuilder plugins

Links can be related regardless of the path, managed by machine names.

A route is an object defined by

1. Path
2. Default values
3. Requirements
4. Options
5. Host
6. Schemes
7. Methods

The Routing component gets routes from

• PHP code:
  • a RouteCollection object
  • closures
  • class annotations
• External files:
  • YAML
  • XML
  • PHP

Drupal 8 uses YAML to define routes

			foo.archive:
  path: '/archive/{month}'
  defaults:
    _content: '\Drupal\foo\Controller\FooController::showArchive'
  requirements:
    month: '[0-9]{4}-[0-9]{2}'
    subdomain: 'www|m'
  host: '{subdomain}.example.com'
		

Defining the route in YAML

/modules/foo/foo.routing.yml

			foo.hello_world:
  path: '/hello-world'
  defaults:
    _controller: '\Drupal\foo\Controller\FooController::helloWorld'
  requirements:
    _access: 'TRUE'
		

Creating the controller

/modules/foo/lib/Controller/FooController.php

			namespace Drupal\foo\Controller;
use Symfony\Component\HttpFoundation\Response;

class FooController {
  public function helloWorld() {
    $response = new Response('Hello World!');
    $response->headers->set('Content-Type', 'text/plain');
    return $response;
  }  
}
		

Drupal 8 will use PSR-4 for module classes instead of PSR-0

/modules/foo/lib/Controller/FooController.php
instead of
/modules/foo/lib/Drupal/foo/Controller/FooController.php

drupal.org issue: https://drupal.org/node/1971198

Returning a JSON response

			namespace Drupal\foo\Controller;
use Symfony\Component\HttpFoundation\JsonResponse

class FooController {

  public function helloWorld() {
    return new JsonResponse(
      array('greeting' => 'Hello World!')
    );
  }  
}
		

{"greeting":"Hello World!"}

Defining the route in YAML

			foo.hello_world:
  path: '/hello-world'
  defaults:
    _content: '\Drupal\foo\Controller\FooController::helloWorld'
    _title: 'Greeting'
  requirements:
    _permission: 'access content'
		

Returning a render array

			namespace Drupal\foo\Controller;
use Drupal\Core\Controller\ControllerBase;

class FooController extends ControllerBase {

  public function helloWorld() {
    $build = array();
    $build['#markup'] = $this->t('Hello World!');
    return $build;
  }
}

		

What about dynamic page titles?

drupal_set_title() is being removed

Use _title_callback in the route defaults

defaults:
  _title_callback: '\Drupal\foo\Controller\FooController::getTitle'

Or return it as part of the main render array

$build['#title'] = ...

Defining the route in YAML

			
foo.admin_greeting:
  path: '/admin/config/people/greeting'
  defaults:
    _form: '\Drupal\foo\Form\FooForm'
  requirements:
    _permission: 'administer greeting'
		

Passing parameters to the controller method

# Parameter defined in the path

			path: '/comment/{comment}/approve'
		

# Default parameter

			path: '/admin/structure/types'
defaults:
  entity_type: 'node_type'
		

# Optional (both in the path and with a default value)

			path: '/admin/config/search/path/{keys}'
defaults:
  keys: NULL
		

Explicitly converting parameters into entities

      
			foo.hello_user:
  path: '/{foo_user}/hello/{user}'
        # e.g. /1/hello/2
        defaults:
    _content: '\...\FooController::helloUser'
  options:
    parameters:
      foo_user:
        type: 'entity:user'
              # {foo_user} will also be passed as a user entity
		

Regular expressions requirements for parameters

# {op} parameter can only be 'enable' or 'disable'

      views_ui.operation:
  path: '/admin/structure/views/view/{view}/{op}'
  requirements:
    op: 'enable|disable'
    

# {user} parameter can only be a number

      user.view:
  path: '/user/{user}'
  requirements:
          user: \d+
    

Drupal 8 doesn't implement Symfony2 Security component, and manages access from routing

Symfony uses a separate Security component for controlling route access that is too complex to integrate in Drupal 8.

Drupal 8 implements access checkers services, which will ignore, allow or deny the access based on a requirement on the route.

Checking Permissions

			node.overview_types:
  path: '/admin/structure/types'
  defaults:
    _content: '\Drupal\Core\Entity\Controller\EntityListController::listing'
    entity_type: 'node_type'
    _title: 'Content types'
  requirements:
    _permission: 'administer content types'
		

Still setting permissions in hook_permission()

			function node_permission() {
  return array(
    'administer content types' => array(
      'title' => t('Administer content types'),
      'restrict access' => TRUE,
    ),
  );
}
		

I asked for hook_permission() in IRC #drupal-contribute

<timplunkett> juanolalla: no plans to replace that AFAIK

Common access checkers provided by Drupal core

# Always pass, or 'FALSE' to always fail and block access

			requirements:
  _access: 'TRUE'
		

# Role IDs separated by "," (any role) or "+" (all roles)

			requirements:
  _role: 'authenticated,admin'
		

# Passes if the user is logged in

    
			requirements:
  _user_is_logged_in: 'TRUE'
		

Declaring your own custom access checker

Declare your requirement checker in .routing.yml

			requirements:
  _you_shall_not_pass: 'TRUE'
		

Register an access checker class as a service (in .services.yml)

			services:
  access_check.foo.gandalf:
    class: Drupal\foo\Access\GandalfAccessCheck
    tags:
      - { name: access_check }