final class MutableResourceTypeLinkProvider in JSON:API Hypermedia 8

Link provider for mutable hypermedia controls.

This plugin provides links on mutable resource objects that indicate the clients ability to update and remove the context resource object. These presence of these links can express access control or other business logic so that those rules do not need to be duplicated in the client.

Plugin annotation


@JsonapiHypermediaLinkProvider(
  id = "jsonapi_hypermedia.mutability_controls",
  deriver = "Drupal\jsonapi_hypermedia\Plugin\Derivative\MutableResourceTypeLinkProviderDeriver",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\jsonapi_hypermedia\Plugin\LinkProviderBase implements LinkProviderInterface
    class \Drupal\jsonapi_hypermedia\Plugin\jsonapi_hypermedia\LinkProvider\MutableResourceTypeLinkProvider implements ContainerFactoryPluginInterface uses ResourceObjectEntityLoaderTrait

Expanded class hierarchy of MutableResourceTypeLinkProvider

File

examples/Plugin/jsonapi_hypermedia/LinkProvider/MutableResourceTypeLinkProvider.php, line 25

Namespace

Drupal\jsonapi_hypermedia\Plugin\jsonapi_hypermedia\LinkProvider

View source

final class MutableResourceTypeLinkProvider extends LinkProviderBase implements ContainerFactoryPluginInterface {
  use ResourceObjectEntityLoaderTrait;

  /**
   * The JSON:API operation.
   *
   * @var string
   */
  protected $operation;

  /**
   * {@inheritdoc}
   */
  protected function __construct(array $configuration, string $plugin_id, mixed $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    assert(!empty($configuration['operation']) && in_array($configuration['operation'], [
      'update',
      'remove',
    ], TRUE), "The operation must be set to either 'update' or 'remove'.");
    $this->operation = $configuration['operation'];
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $provider = new static($configuration, $plugin_id, $plugin_definition);
    $provider
      ->setEntityRepository($container
      ->get('entity.repository'));
    return $provider;
  }

  /**
   * {@inheritdoc}
   */
  public function getLink($resource_object) {
    assert($resource_object instanceof ResourceObject);
    $entity = $this
      ->loadEntityFromResourceObject($resource_object);
    $entity_operation_mapping = [
      'update' => 'update',
      'remove' => 'delete',
    ];
    $access = $entity
      ->access($entity_operation_mapping[$this->operation], NULL, TRUE);
    return AccessRestrictedLink::createLink($access, new CacheableMetadata(), $resource_object
      ->toUrl(), $this
      ->getLinkRelationType());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LinkProviderBase::getLinkKey	public	function	Gets the link object key for the provided link. Overrides LinkProviderInterface::getLinkKey
LinkProviderBase::getLinkRelationType	public	function	Gets the link relation type for the provided link. Overrides LinkProviderInterface::getLinkRelationType	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
MutableResourceTypeLinkProvider::$operation	protected	property	The JSON:API operation.
MutableResourceTypeLinkProvider::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MutableResourceTypeLinkProvider::getLink	public	function	Adds, alters or removes hyperlinks from a link collection. Overrides LinkProviderInterface::getLink
MutableResourceTypeLinkProvider::__construct	protected	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ResourceObjectEntityLoaderTrait::$entityRepository	protected	property	The entity repository.
ResourceObjectEntityLoaderTrait::loadEntityFromResourceObject	public	function	Gets the entity represented by the given resource object.
ResourceObjectEntityLoaderTrait::setEntityRepository	protected	function	Sets the entity repository.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here