You are here

Home » API reference » Services 9.0.x » ServiceResource.php

class ServiceResource in Services 9.0.x

Same name and namespace in other branches
  1. 8.4 src/Entity/ServiceResource.php \Drupal\services\Entity\ServiceResource

Defines service resource entity.

Plugin annotation


@ConfigEntityType(
  id = "service_endpoint_resource",
  label = @Translation("Resource"),
  handlers = {
    "form" = {
      "config" = "\Drupal\services\Form\ServiceResourceConfigForm",
      "delete" = "\Drupal\services\Form\ServiceResourceDeleteForm"
    }
  },
  entity_keys = {
    "id" = "id",
    "uuid" = "uuid",
  },
  config_prefix = "endpoint_resource",
  admin_permission = "administer site configuration",
  links = {
    "config-form" = "/admin/structure/service_endpoint/{service_endpoint}/resource/{plugin_id}",
    "delete-form" = "/admin/structure/service_endpoint/{service_endpoint}/resource/{plugin_id}/delete"
   },
  config_export = {
    "id",
    "service_plugin_id",
    "service_endpoint_id",
    "formats",
    "authentication",
  }
)

Hierarchy

Expanded class hierarchy of ServiceResource

1 file declares its use of ServiceResource
ServiceResourceTest.php in tests/src/Unit/Entity/ServiceResourceTest.php

File

src/Entity/ServiceResource.php, line 41

Namespace

Drupal\services\Entity
View source 
class ServiceResource extends ConfigEntityBase implements ServiceResourceInterface {

  /**
   * Resource ID.
   *
   * @var string
   */
  protected $id;

  /**
   * Service plugin ID.
   *
   * @var string
   */
  protected $service_plugin_id;

  /**
   * Service endpoint ID.
   *
   * @var string
   */
  protected $service_endpoint_id;

  /**
   * Resource formats.
   *
   * @var array
   */
  protected $formats = [];

  /**
   * Resource authentication.
   *
   * @var array
   */
  protected $authentication = [];

  /**
   * Resource no cache option.
   *
   * @var array
   */
  protected $no_cache = NULL;

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->service_endpoint_id . '.' . strtr($this->service_plugin_id, ':', '.');
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    if ($service_plugin = $this
      ->getServicePlugin()) {
      return $service_plugin['title'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getFormats() {
    if (!empty($this->formats)) {
      return array_filter($this->formats);
    }
    return $this
      ->getDefaultSettings()
      ->get('default_formats');
  }

  /**
   * {@inheritdoc}
   */
  public function getAuthentication() {
    if (!empty($this->authentication)) {
      return array_filter($this->authentication);
    }
    return $this
      ->getDefaultSettings()
      ->get('default_authentication');
  }

  /**
   * {@inheritdoc}
   */
  public function getNoCache() {
    if (isset($this->no_cache)) {
      return $this->no_cache;
    }
    return $this
      ->getDefaultSettings()
      ->get('default_no_cache');
  }

  /**
   * Get service plugin definition.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   A service plugin definition.
   */
  public function getServicePlugin() {
    if (!$this
      ->hasServicePlugin()) {
      return FALSE;
    }
    return $this
      ->serviceDefinition()
      ->getDefinition($this->service_plugin_id);
  }

  /**
   * Create service plugin instance.
   *
   * @param array $values
   *   An array of values to pass into the instance.
   *
   * @return \Drupal\services\ServiceDefinitionInterface
   *   A service definition instance.
   */
  public function createServicePluginInstance(array $values = []) {
    if (!$this
      ->hasServicePlugin()) {
      return FALSE;
    }
    return $this
      ->serviceDefinition()
      ->createInstance($this->service_plugin_id, $values);
  }

  /**
   * Has a service plugin definition.
   *
   * @return bool
   *   TRUE if a service plugin exists; otherwise FALSE.
   */
  public function hasServicePlugin() {
    if (!isset($this->service_plugin_id)) {
      return FALSE;
    }
    return $this
      ->serviceDefinition()
      ->hasDefinition($this->service_plugin_id);
  }

  /**
   * Service endpoint object.
   */
  public function getEndpoint() {
    return $this
      ->entityTypeManager()
      ->getStorage('service_endpoint')
      ->load($this->service_endpoint_id);
  }

  /**
   * {@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();
  }

  /**
   * Service default global settings.
   *
   * @return \Drupal\Core\Config\Config
   *   A configuration object.
   */
  public function getDefaultSettings() {
    return $this
      ->getConfigManager()
      ->getConfigFactory()
      ->get('services.settings');
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Calculate the dependencies based on the selected authentications that
    // have been selected for a given services resource.
    if ($this instanceof ServiceResourceInterface) {
      foreach ($this
        ->getAuthentication() as $provider_id) {
        $provider = $this
          ->authenticationCollector()
          ->getProvider($provider_id);
        if (!$provider instanceof AuthenticationProviderInterface) {
          continue;
        }
        $class_info = explode('\\', get_class($provider));
        $module_name = $class_info[1];

        // Make sure the module exists prior to requiring it as a dependency.
        if (\Drupal::moduleHandler()
          ->moduleExists($module_name)) {
          $this
            ->addDependency('module', $module_name);
        }
      }
    }
    return $this;
  }

  /**
   * Service plugin definition.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   A plugin manager for the service definition.
   */
  protected function serviceDefinition() {
    return \Drupal::service('plugin.manager.services.service_definition');
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    if (!in_array($rel, [
      'collection',
      'add-page',
      'add-form',
    ], TRUE)) {
      $uri_route_parameters['plugin_id'] = $this->service_plugin_id;
      $uri_route_parameters['service_endpoint'] = $this->service_endpoint_id;
    }
    return $uri_route_parameters;
  }

  /**
   * Authentication collector.
   *
   * @return \Drupal\Core\Authentication\AuthenticationCollectorInterface.
   *   An authentication collection object.
   */
  protected function authenticationCollector() {
    return \Drupal::service('authentication_collector');
  }

}

Members

Namesort descending Modifiers Type Description 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 Third party entity settings.
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::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
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 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
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 2
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::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
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
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
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::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
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 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
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::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
ServiceResource::$authentication protected property Resource authentication.
ServiceResource::$formats protected property Resource formats.
ServiceResource::$id protected property Resource ID.
ServiceResource::$no_cache protected property Resource no cache option.
ServiceResource::$service_endpoint_id protected property Service endpoint ID.
ServiceResource::$service_plugin_id protected property Service plugin ID.
ServiceResource::authenticationCollector protected function Authentication collector.
ServiceResource::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
ServiceResource::createServicePluginInstance public function Create service plugin instance.
ServiceResource::getAuthentication public function Get resource allowed authentication. Overrides ServiceResourceInterface::getAuthentication
ServiceResource::getDefaultSettings public function Service default global settings.
ServiceResource::getEndpoint public function Service endpoint object.
ServiceResource::getFormats public function Get resource allowed formats. Overrides ServiceResourceInterface::getFormats
ServiceResource::getNoCache public function Get resource no caching option. Overrides ServiceResourceInterface::getNoCache
ServiceResource::getServicePlugin public function Get service plugin definition.
ServiceResource::hasServicePlugin public function Has a service plugin definition.
ServiceResource::id public function Gets the identifier. Overrides EntityBase::id
ServiceResource::label public function Gets the label of the entity. Overrides EntityBase::label
ServiceResource::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
ServiceResource::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
ServiceResource::serviceDefinition protected function Service plugin definition.
ServiceResource::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function