final class TestLinkProvider in JSON:API Hypermedia 8

Class TestLinkProvider.

@JsonapiHypermediaLinkProvider( id = "test_link_provider", deriver = "\Drupal\jsonapi_hypermedia_test_link_providers\Plugin\Derivative\TestLinkProviderDeriver", )

@internal

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_test_link_providers\Plugin\jsonapi_hypermedia\LinkProvider\TestLinkProvider implements ContainerFactoryPluginInterface

File

tests/modules/jsonapi_hypermedia_test_link_providers/src/Plugin/jsonapi_hypermedia/LinkProvider/TestLinkProvider.php, line 25

Namespace

Drupal\jsonapi_hypermedia_test_link_providers\Plugin\jsonapi_hypermedia\LinkProvider

final class TestLinkProvider extends LinkProviderBase implements ContainerFactoryPluginInterface {

  /**
   * The current user account.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

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

  /**
   * Sets the current account.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current user account.
   */
  protected function setCurrentAccount(AccountInterface $account) {
    $this->account = $account;
  }

  /**
   * {@inheritdoc}
   */
  public function getLink($context) {
    $plugin_definition = $this
      ->getPluginDefinition();
    $link_key = $this
      ->getLinkKey();
    $url = Url::fromUri("https://drupal.org/project/jsonapi_hypermedia/{$link_key}");
    $random = (new Random())
      ->name();
    $attributes = array_merge($plugin_definition['_test_target_attributes'] ?? [], [
      'randomAttr' => $random,
    ]);
    $access_restricted = !empty($plugin_definition['_test_restrict_access']);
    $cacheability = new CacheableMetadata();
    $cacheability
      ->addCacheTags([
      'test_jsonapi_hypermedia_cache_tag',
    ]);
    $permission = "view {$this->getLinkKey()} link";
    $access_result = $access_restricted ? AccessResult::allowedIfHasPermission($this->account, $permission) : AccessResult::allowed();
    return AccessRestrictedLink::createLink($access_result, $cacheability, $url, $this
      ->getLinkRelationType(), $attributes);
  }

}

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.
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.
TestLinkProvider::$account	protected	property	The current user account.
TestLinkProvider::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TestLinkProvider::getLink	public	function	Adds, alters or removes hyperlinks from a link collection. Overrides LinkProviderInterface::getLink
TestLinkProvider::setCurrentAccount	protected	function	Sets the current account.