interface RestResourceConfigInterface

Same name and namespace in other branches
  1. 11.x core/modules/rest/src/RestResourceConfigInterface.php \Drupal\rest\RestResourceConfigInterface
  2. 10 core/modules/rest/src/RestResourceConfigInterface.php \Drupal\rest\RestResourceConfigInterface
  3. 8.9.x core/modules/rest/src/RestResourceConfigInterface.php \Drupal\rest\RestResourceConfigInterface

Defines a configuration entity to store enabled REST resources.

Hierarchy

Expanded class hierarchy of RestResourceConfigInterface

All classes that implement RestResourceConfigInterface

16 files declare their use of RestResourceConfigInterface
ConfigDependencies.php in core/modules/rest/src/Entity/ConfigDependencies.php
ConfigDependenciesTest.php in core/modules/rest/tests/src/Kernel/Entity/ConfigDependenciesTest.php
ConfigDependenciesTest.php in core/modules/hal/tests/src/Kernel/rest/Entity/ConfigDependenciesTest.php
ContentModerationStateResourceTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationStateResourceTest.php
FileUploadResourceTestBase.php in core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php

... See full list

File

core/modules/rest/src/RestResourceConfigInterface.php, line 11

Namespace

Drupal\rest
View source
interface RestResourceConfigInterface extends ConfigEntityInterface, EntityWithPluginCollectionInterface {
  
  /**
   * Granularity value for per-method configuration.
   */
  const METHOD_GRANULARITY = 'method';
  
  /**
   * Granularity value for per-resource configuration.
   */
  const RESOURCE_GRANULARITY = 'resource';
  
  /**
   * Retrieves the REST resource plugin.
   *
   * @return \Drupal\rest\Plugin\ResourceInterface
   *   The resource plugin
   */
  public function getResourcePlugin();
  
  /**
   * Retrieves a list of supported HTTP methods.
   *
   * @return string[]
   *   A list of supported HTTP methods.
   */
  public function getMethods();
  
  /**
   * Retrieves a list of supported authentication providers.
   *
   * @param string $method
   *   The request method e.g GET or POST.
   *
   * @return string[]
   *   A list of supported authentication provider IDs.
   */
  public function getAuthenticationProviders($method);
  
  /**
   * Retrieves a list of supported response formats.
   *
   * @param string $method
   *   The request method e.g GET or POST.
   *
   * @return string[]
   *   A list of supported format IDs.
   */
  public function getFormats($method);

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.