interface RestResourceConfigInterface

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

Defines a configuration entity to store enabled REST resources.

Hierarchy

  • interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityWithPluginCollectionInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Plugin\ObjectWithPluginCollectionInterface
    • interface \Drupal\rest\RestResourceConfigInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface \Drupal\Core\Entity\EntityWithPluginCollectionInterface

Expanded class hierarchy of RestResourceConfigInterface

All classes that implement RestResourceConfigInterface

14 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
ContentModerationStateResourceTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationStateResourceTest.php
FileUploadResourceTestBase.php in core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php
MediaResourceTestBase.php in core/modules/media/tests/src/Functional/Rest/MediaResourceTestBase.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);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RestResourceConfigInterface::getAuthenticationProviders public function Retrieves a list of supported authentication providers. 1
RestResourceConfigInterface::getFormats public function Retrieves a list of supported response formats. 1
RestResourceConfigInterface::getMethods public function Retrieves a list of supported HTTP methods. 1
RestResourceConfigInterface::getResourcePlugin public function Retrieves the REST resource plugin. 1
RestResourceConfigInterface::METHOD_GRANULARITY constant Granularity value for per-method configuration.
RestResourceConfigInterface::RESOURCE_GRANULARITY constant Granularity value for per-resource configuration.
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 4
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 4
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 4
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 4
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 4

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