You are here

Home » API reference » JSON:API Hypermedia 8 » EntityPublishedInterfaceLinkProvider.php

final class EntityPublishedInterfaceLinkProvider in JSON:API Hypermedia 8

Class EntityPublishedInterfaceLinkProvider.

This example shows how a link provider can provide easy-to-follow links that further decouple a client implementation from the backend. In this case, the client no longer needs to hard-code the correct field name to update on a per-resource-type basis, nor does it need to perform complicated business logic to check if the resource is already published or not—the presence of the link conveys that information. Finally, if the backend later decides that some user role is no allowed to publish content, the client does not need to be updated to account for that change (the link will just disappear).

@JsonapiHypermediaLinkProvider( id = "jsonapi_hypermedia.entity_published", deriver = "Drupal\jsonapi_hypermedia\Plugin\Derivative\EntityPublishedInterfaceLinkProviderDeriver", )

@internal

Hierarchy

Expanded class hierarchy of EntityPublishedInterfaceLinkProvider

File

examples/Plugin/jsonapi_hypermedia/LinkProvider/EntityPublishedInterfaceLinkProvider.php, line 33

Namespace

Drupal\jsonapi_hypermedia\Plugin\jsonapi_hypermedia\LinkProvider
View source 
final class EntityPublishedInterfaceLinkProvider extends LinkProviderBase implements ContainerFactoryPluginInterface {
  use ResourceObjectEntityLoaderTrait;

  /**
   * The published status internal field name.
   *
   * @var string
   */
  protected $statusFieldName;

  /**
   * {@inheritdoc}
   */
  protected function __construct(array $configuration, string $plugin_id, mixed $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    assert(!empty($configuration['status_field_name']) && is_string($configuration['status_field_name']), "The status_field_name configuration value is required.");
    $this->statusFieldName = $configuration['status_field_name'];
  }

  /**
   * {@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);
    $resource_type = $resource_object
      ->getResourceType();
    $entity = $this
      ->loadEntityFromResourceObject($resource_object);
    assert($entity instanceof EntityPublishedInterface);
    $plugin_definition = $this
      ->getPluginDefinition();
    $published = $entity
      ->isPublished();
    $publish_operation = $plugin_definition['link_key'] === 'publish';
    $access_result = AccessResult::allowedIf($publish_operation !== $published)
      ->andIf($entity
      ->access('update', NULL, TRUE))
      ->andIf($entity->{$this->statusFieldName}
      ->access('edit', NULL, TRUE))
      ->addCacheableDependency($entity);
    $link_attributes = [
      'data' => [
        'type' => $resource_object
          ->getTypeName(),
        'id' => $resource_object
          ->getId(),
        'attributes' => [
          $resource_type
            ->getPublicName($this->statusFieldName) => (int) (!$published),
        ],
      ],
    ];
    return AccessRestrictedLink::createLink($access_result, CacheableMetadata::createFromObject($resource_object), $resource_object
      ->toUrl(), $this
      ->getLinkRelationType(), $link_attributes);
  }

}

Members

Namesort descending 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
EntityPublishedInterfaceLinkProvider::$statusFieldName protected property The published status internal field name.
EntityPublishedInterfaceLinkProvider::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityPublishedInterfaceLinkProvider::getLink public function Adds, alters or removes hyperlinks from a link collection. Overrides LinkProviderInterface::getLink
EntityPublishedInterfaceLinkProvider::__construct protected function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.
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.