Mercurial > hg > cmmr2012-drupal-site
diff core/modules/rest/src/RestResourceConfigInterface.php @ 0:c75dbcec494b
Initial commit from drush-created site
author | Chris Cannam |
---|---|
date | Thu, 05 Jul 2018 14:24:15 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/modules/rest/src/RestResourceConfigInterface.php Thu Jul 05 14:24:15 2018 +0000 @@ -0,0 +1,61 @@ +<?php + +namespace Drupal\rest; + +use Drupal\Core\Config\Entity\ConfigEntityInterface; +use Drupal\Core\Entity\EntityWithPluginCollectionInterface; + +/** + * Defines a configuration entity to store enabled REST resources. + */ +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); + +}