class RestResourceConfig

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

Defines a RestResourceConfig configuration entity class.

Plugin annotation


@ConfigEntityType(
  id = "rest_resource_config",
  label = @Translation("REST resource configuration"),
  label_collection = @Translation("REST resource configurations"),
  label_singular = @Translation("REST resource configuration"),
  label_plural = @Translation("REST resource configurations"),
  label_count = @PluralTranslation(
    singular = "@count REST resource configuration",
    plural = "@count REST resource configurations",
  ),
  config_prefix = "resource",
  admin_permission = "administer rest resources",
  entity_keys = {
    "id" = "id"
  },
  config_export = {
    "id",
    "plugin_id",
    "granularity",
    "configuration"
  }
)

Hierarchy

Expanded class hierarchy of RestResourceConfig

10 files declare their use of RestResourceConfig
ConfigDependenciesTest.php in core/modules/rest/tests/src/Kernel/Entity/ConfigDependenciesTest.php
ContentModerationStateResourceTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationStateResourceTest.php
ResourceTest.php in core/modules/rest/tests/src/Functional/ResourceTest.php
ResponseGeneratorTest.php in core/modules/system/tests/src/Functional/System/ResponseGeneratorTest.php
RestPermissionsTest.php in core/modules/rest/tests/src/Kernel/Entity/RestPermissionsTest.php

... See full list

File

core/modules/rest/src/Entity/RestResourceConfig.php, line 36

Namespace

Drupal\rest\Entity
View source
class RestResourceConfig extends ConfigEntityBase implements RestResourceConfigInterface {
    
    /**
     * The REST resource config id.
     *
     * @var string
     */
    protected $id;
    
    /**
     * The REST resource plugin id.
     *
     * @var string
     */
    protected $plugin_id;
    
    /**
     * The REST resource configuration granularity.
     *
     * Currently either:
     * - \Drupal\rest\RestResourceConfigInterface::METHOD_GRANULARITY
     * - \Drupal\rest\RestResourceConfigInterface::RESOURCE_GRANULARITY
     *
     * @var string
     */
    protected $granularity;
    
    /**
     * The REST resource configuration.
     *
     * @var array
     */
    protected $configuration;
    
    /**
     * The rest resource plugin manager.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $pluginManager;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $values, $entity_type) {
        parent::__construct($values, $entity_type);
        // The config entity id looks like the plugin id but uses __ instead of :
        // because : is not valid for config entities.
        if (!isset($this->plugin_id) && isset($this->id)) {
            // Generate plugin_id on first entity creation.
            $this->plugin_id = str_replace('.', ':', $this->id);
        }
    }
    
    /**
     * Returns the resource plugin manager.
     *
     * @return \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected function getResourcePluginManager() {
        if (!isset($this->pluginManager)) {
            $this->pluginManager = \Drupal::service('plugin.manager.rest');
        }
        return $this->pluginManager;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getResourcePlugin() {
        return $this->getPluginCollections()['resource']
            ->get($this->plugin_id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMethods() {
        switch ($this->granularity) {
            case RestResourceConfigInterface::METHOD_GRANULARITY:
                return $this->getMethodsForMethodGranularity();
            case RestResourceConfigInterface::RESOURCE_GRANULARITY:
                return $this->configuration['methods'];
            default:
                throw new \InvalidArgumentException('Invalid granularity specified.');
        }
    }
    
    /**
     * Retrieves a list of supported HTTP methods for this resource.
     *
     * @return string[]
     *   A list of supported HTTP methods.
     */
    protected function getMethodsForMethodGranularity() {
        $methods = array_keys($this->configuration);
        return array_map([
            $this,
            'normalizeRestMethod',
        ], $methods);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getAuthenticationProviders($method) {
        switch ($this->granularity) {
            case RestResourceConfigInterface::METHOD_GRANULARITY:
                return $this->getAuthenticationProvidersForMethodGranularity($method);
            case RestResourceConfigInterface::RESOURCE_GRANULARITY:
                return $this->configuration['authentication'];
            default:
                throw new \InvalidArgumentException('Invalid granularity specified.');
        }
    }
    
    /**
     * 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 getAuthenticationProvidersForMethodGranularity($method) {
        $method = $this->normalizeRestMethod($method);
        if (in_array($method, $this->getMethods()) && isset($this->configuration[$method]['supported_auth'])) {
            return $this->configuration[$method]['supported_auth'];
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormats($method) {
        switch ($this->granularity) {
            case RestResourceConfigInterface::METHOD_GRANULARITY:
                return $this->getFormatsForMethodGranularity($method);
            case RestResourceConfigInterface::RESOURCE_GRANULARITY:
                return $this->configuration['formats'];
            default:
                throw new \InvalidArgumentException('Invalid granularity specified.');
        }
    }
    
    /**
     * 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.
     */
    protected function getFormatsForMethodGranularity($method) {
        $method = $this->normalizeRestMethod($method);
        if (in_array($method, $this->getMethods()) && isset($this->configuration[$method]['supported_formats'])) {
            return $this->configuration[$method]['supported_formats'];
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPluginCollections() {
        return [
            'resource' => new DefaultSingleLazyPluginCollection($this->getResourcePluginManager(), $this->plugin_id, []),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        parent::calculateDependencies();
        foreach ($this->getRestResourceDependencies()
            ->calculateDependencies($this) as $type => $dependencies) {
            foreach ($dependencies as $dependency) {
                $this->addDependency($type, $dependency);
            }
        }
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function onDependencyRemoval(array $dependencies) {
        $parent = parent::onDependencyRemoval($dependencies);
        // If the dependency problems are not marked as fixed at this point they
        // should be related to the resource plugin and the config entity should
        // be deleted.
        $changed = $this->getRestResourceDependencies()
            ->onDependencyRemoval($this, $dependencies);
        return $parent || $changed;
    }
    
    /**
     * Returns the REST resource dependencies.
     *
     * @return \Drupal\rest\Entity\ConfigDependencies
     */
    protected function getRestResourceDependencies() {
        return \Drupal::service('class_resolver')->getInstanceFromDefinition(ConfigDependencies::class);
    }
    
    /**
     * Normalizes the method.
     *
     * @param string $method
     *   The request method.
     *
     * @return string
     *   The normalized request method.
     */
    protected function normalizeRestMethod($method) {
        return strtoupper($method);
    }
    
    /**
     * {@inheritdoc}
     */
    public function postSave(EntityStorageInterface $storage, $update = TRUE) {
        parent::postSave($storage, $update);
        \Drupal::service('router.builder')->setRebuildNeeded();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postDelete(EntityStorageInterface $storage, array $entities) {
        parent::postDelete($storage, $entities);
        \Drupal::service('router.builder')->setRebuildNeeded();
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 14
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 2
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 3
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 2
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 10
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 5
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
RestResourceConfig::$configuration protected property The REST resource configuration.
RestResourceConfig::$granularity protected property The REST resource configuration granularity.
RestResourceConfig::$id protected property The REST resource config id.
RestResourceConfig::$pluginManager protected property The rest resource plugin manager.
RestResourceConfig::$plugin_id protected property The REST resource plugin id.
RestResourceConfig::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
RestResourceConfig::getAuthenticationProviders public function Retrieves a list of supported authentication providers. Overrides RestResourceConfigInterface::getAuthenticationProviders
RestResourceConfig::getAuthenticationProvidersForMethodGranularity public function Retrieves a list of supported authentication providers.
RestResourceConfig::getFormats public function Retrieves a list of supported response formats. Overrides RestResourceConfigInterface::getFormats
RestResourceConfig::getFormatsForMethodGranularity protected function Retrieves a list of supported response formats.
RestResourceConfig::getMethods public function Retrieves a list of supported HTTP methods. Overrides RestResourceConfigInterface::getMethods
RestResourceConfig::getMethodsForMethodGranularity protected function Retrieves a list of supported HTTP methods for this resource.
RestResourceConfig::getPluginCollections public function
RestResourceConfig::getResourcePlugin public function Retrieves the REST resource plugin. Overrides RestResourceConfigInterface::getResourcePlugin
RestResourceConfig::getResourcePluginManager protected function Returns the resource plugin manager.
RestResourceConfig::getRestResourceDependencies protected function Returns the REST resource dependencies.
RestResourceConfig::normalizeRestMethod protected function Normalizes the method.
RestResourceConfig::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase::onDependencyRemoval
RestResourceConfig::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
RestResourceConfig::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
RestResourceConfig::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct
RestResourceConfigInterface::METHOD_GRANULARITY constant Granularity value for per-method configuration.
RestResourceConfigInterface::RESOURCE_GRANULARITY constant Granularity value for per-resource configuration.
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function

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