You are here

interface ResourceInterface in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/rest/src/Plugin/ResourceInterface.php \Drupal\rest\Plugin\ResourceInterface

Specifies the publicly available methods of a resource plugin.

Hierarchy

Expanded class hierarchy of ResourceInterface

All classes that implement ResourceInterface

See also

\Drupal\rest\Annotation\RestResource

\Drupal\rest\Plugin\Type\ResourcePluginManager

\Drupal\rest\Plugin\ResourceBase

Plugin API

Related topics

1 file declares its use of ResourceInterface
RequestHandler.php in core/modules/rest/src/RequestHandler.php

File

core/modules/rest/src/Plugin/ResourceInterface.php, line 17

Namespace

Drupal\rest\Plugin
View source
interface ResourceInterface extends PluginInspectionInterface {

  /**
   * Returns a collection of routes with URL path information for the resource.
   *
   * This method determines where a resource is reachable, what path
   * replacements are used, the required HTTP method for the operation etc.
   *
   * @return \Symfony\Component\Routing\RouteCollection
   *   A collection of routes that should be registered for this resource.
   */
  public function routes();

  /**
   * Provides an array of permissions suitable for .permissions.yml files.
   *
   * A resource plugin can define a set of user permissions that are used on the
   * routes for this resource or for other purposes.
   *
   * It is not required for a resource plugin to specify permissions: if they
   * have their own access control mechanism, they can use that, and return the
   * empty array.
   *
   * @return array
   *   The permission array.
   */
  public function permissions();

  /**
   * Returns the available HTTP request methods on this plugin.
   *
   * @return array
   *   The list of supported methods. Example: array('GET', 'POST', 'PATCH').
   */
  public function availableMethods();

}

Members

Namesort descending Modifiers Type Description Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ResourceInterface::availableMethods public function Returns the available HTTP request methods on this plugin. 1
ResourceInterface::permissions public function Provides an array of permissions suitable for .permissions.yml files. 1
ResourceInterface::routes public function Returns a collection of routes with URL path information for the resource. 1