You are here

abstract class LinkProviderBase in JSON:API Hypermedia 8

Class LinkProviderBase.

Hierarchy

Expanded class hierarchy of LinkProviderBase

4 files declare their use of LinkProviderBase
AuthenticationLinkProvider.php in examples/Plugin/jsonapi_hypermedia/LinkProvider/AuthenticationLinkProvider.php
EntityPublishedInterfaceLinkProvider.php in examples/Plugin/jsonapi_hypermedia/LinkProvider/EntityPublishedInterfaceLinkProvider.php
MutableResourceTypeLinkProvider.php in examples/Plugin/jsonapi_hypermedia/LinkProvider/MutableResourceTypeLinkProvider.php
TestLinkProvider.php in tests/modules/jsonapi_hypermedia_test_link_providers/src/Plugin/jsonapi_hypermedia/LinkProvider/TestLinkProvider.php

File

src/Plugin/LinkProviderBase.php, line 11

Namespace

Drupal\jsonapi_hypermedia\Plugin
View source
abstract class LinkProviderBase extends PluginBase implements LinkProviderInterface {

  /**
   * {@inheritdoc}
   */
  public function getLinkKey() {
    $plugin_definition = $this
      ->getPluginDefinition();
    return $plugin_definition['link_key'] ?? $this
      ->getLinkRelationType();
  }

  /**
   * {@inheritdoc}
   */
  public function getLinkRelationType() {
    $plugin_definition = $this
      ->getPluginDefinition();
    return $plugin_definition['link_relation_type'];
  }

}

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
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
LinkProviderInterface::getLink public function Adds, alters or removes hyperlinks from a link collection. 4
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.