public function ResourceBase::routes

Implements ResourceInterface::routes().

Overrides ResourceInterface::routes

File

drupal/core/modules/rest/lib/Drupal/rest/Plugin/ResourceBase.php, line 41

Definition of Drupal\rest\Plugin\ResourceBase.

Class

ResourceBase

Common base class for resource plugins.

Namespace

Code

public function routes() {
  $collection = new RouteCollection();
  $path_prefix = strtr($this->pluginId, ':', '/');
  $route_name = strtr($this->pluginId, ':', '.');
  $methods = $this
    ->availableMethods();
  foreach ($methods as $method) {
    $lower_method = strtolower($method);
    $route = new Route("/{$path_prefix}/{id}", array(
      '_controller' => 'Drupal\\rest\\RequestHandler::handle',
      // Pass the resource plugin ID along as default property.
      '_plugin' => $this->pluginId,
    ), array(
      // The HTTP method is a requirement for this route.
      '_method' => $method,
      '_permission' => "restful {$lower_method} {$this->pluginId}",
    ));
    switch ($method) {
      case 'POST':

        // POST routes do not require an ID in the URL path.
        $route
          ->setPattern("/{$path_prefix}");
        $route
          ->addDefaults(array(
          'id' => NULL,
        ));
        $collection
          ->add("{$route_name}.{$method}", $route);
        break;
      case 'GET':
      case 'HEAD':

        // Restrict GET and HEAD requests to the media type specified in the
        // HTTP Accept headers.
        $formats = drupal_container()
          ->getParameter('serializer.formats');
        foreach ($formats as $format_name) {

          // Expose one route per available format.

          //$format_route = new Route($route->getPattern(), $route->getDefaults(), $route->getRequirements());
          $format_route = clone $route;
          $format_route
            ->addRequirements(array(
            '_format' => $format_name,
          ));
          $collection
            ->add("{$route_name}.{$method}.{$format_name}", $format_route);
        }
        break;
      default:
        $collection
          ->add("{$route_name}.{$method}", $route);
        break;
    }
  }
  return $collection;
}