You are here

Home » API reference » Entity Extra Field 8 » ExtraFieldEntityLinkPlugin.php

class ExtraFieldEntityLinkPlugin in Entity Extra Field 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/ExtraFieldType/ExtraFieldEntityLinkPlugin.php \Drupal\entity_extra_field\Plugin\ExtraFieldType\ExtraFieldEntityLinkPlugin

Define the extra field entity link type.

Plugin annotation


@ExtraFieldType(
  id = "entity_link",
  label = @Translation("Entity link")
)

Hierarchy

Expanded class hierarchy of ExtraFieldEntityLinkPlugin

File

src/Plugin/ExtraFieldType/ExtraFieldEntityLinkPlugin.php, line 22

Namespace

Drupal\entity_extra_field\Plugin\ExtraFieldType
View source 
class ExtraFieldEntityLinkPlugin extends ExtraFieldTypePluginBase {

  /**
   * {@inheritDoc}
   */
  public function defaultConfiguration() {
    return [
      'link_text' => NULL,
      'link_template' => NULL,
      'link_target' => NULL,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritDoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $configuration = $this
      ->getConfiguration();
    $form['link_template'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Link Template'),
      '#require' => TRUE,
      '#options' => $this
        ->getEntityLinkTemplateOptions(),
      '#empty_option' => $this
        ->t('- Select -'),
      '#required' => TRUE,
      '#default_value' => $configuration['link_template'],
    ];
    $form['link_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link Text'),
      '#default_value' => $configuration['link_text'],
      '#size' => 25,
      '#required' => TRUE,
    ];
    $form['link_target'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Link Target'),
      '#options' => [
        '_blank',
      ],
      '#empty_option' => $this
        ->t('- Default -'),
      '#default_value' => $configuration['link_target'],
    ];
    return $form;
  }

  /**
   * Build the render array of the extra field type contents.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity type the extra field is being attached too.
   * @param \Drupal\Core\Entity\Display\EntityDisplayInterface $display
   *   The entity display the extra field is apart of.
   *
   * @return array
   *   The extra field renderable array.
   *
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  public function build(EntityInterface $entity, EntityDisplayInterface $display) {
    $link = $this
      ->buildEntityLink($entity);

    // Link and Url seem not to have convenience methods for access including
    // cacheability. So inlining a variant of \Drupal\Core\Url::access
    $accessResult = $this
      ->urlAccessResult($link
      ->getUrl());
    $build = $accessResult
      ->isAllowed() ? $link
      ->toRenderable() : [];
    BubbleableMetadata::createFromObject($accessResult)
      ->applyTo($build);
    return $build;
  }

  /**
   * A copy of \Drupal\Core\Url::access that returns cacheability.
   *
   * @param \Drupal\Core\Url $url
   *   The url.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   (optional) Run access checks for this account. Defaults to the current
   *   user.
   *
   * @return \Drupal\Core\Access\AccessResultInterface Returns url access result object.
   *   Returns url access result object.
   */
  public function urlAccessResult(Url $url, AccountInterface $account = NULL) {
    if ($url
      ->isRouted()) {

      /** @var \Drupal\Core\Access\AccessManagerInterface $accessManager */
      $accessManager = \Drupal::service('access_manager');
      return $accessManager
        ->checkNamedRoute($url
        ->getRouteName(), $url
        ->getRouteParameters(), $account, TRUE);
    }
    return AccessResult::allowed();
  }

  /**
   * Build the entity link.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity instance.
   *
   * @return \Drupal\Core\Link
   *   The entity link instance.
   *
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  protected function buildEntityLink(EntityInterface $entity) {
    $configuration = $this
      ->getConfiguration();
    return $entity
      ->toLink($configuration['link_text'], $configuration['link_template'], $this
      ->getEntityLinkOptions());
  }

  /**
   * Get the entity link options.
   *
   * @return array
   *   An array of the link options.
   */
  protected function getEntityLinkOptions() {
    $options = [];
    $configuration = $this
      ->getConfiguration();
    if ($target = $configuration['link_target']) {
      $options['attributes']['target'] = $target;
    }
    return $options;
  }

  /**
   * Get entity link template options.
   *
   * @return array
   *   An array of the entity template options.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getEntityLinkTemplateOptions() {
    $templates = array_keys($this
      ->getTargetEntityTypeDefinition()
      ->getLinkTemplates());
    return array_combine($templates, $templates);
  }

}

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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
ExtraFieldEntityLinkPlugin::build public function Build the render array of the extra field type contents. Overrides ExtraFieldTypePluginInterface::build
ExtraFieldEntityLinkPlugin::buildConfigurationForm public function Form constructor. Overrides ExtraFieldTypePluginBase::buildConfigurationForm
ExtraFieldEntityLinkPlugin::buildEntityLink protected function Build the entity link.
ExtraFieldEntityLinkPlugin::defaultConfiguration public function Gets default configuration for this plugin. Overrides ExtraFieldTypePluginBase::defaultConfiguration
ExtraFieldEntityLinkPlugin::getEntityLinkOptions protected function Get the entity link options.
ExtraFieldEntityLinkPlugin::getEntityLinkTemplateOptions protected function Get entity link template options.
ExtraFieldEntityLinkPlugin::urlAccessResult public function A copy of \Drupal\Core\Url::access that returns cacheability.
ExtraFieldTypePluginBase::$currentRouteMatch protected property
ExtraFieldTypePluginBase::$entityFieldManager protected property
ExtraFieldTypePluginBase::$entityTypeManager protected property
ExtraFieldTypePluginBase::$moduleHandler protected property
ExtraFieldTypePluginBase::$token protected property
ExtraFieldTypePluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
ExtraFieldTypePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
ExtraFieldTypePluginBase::extraFieldPluginAjax protected function Get extra field plugin ajax properties.
ExtraFieldTypePluginBase::extraFieldPluginAjaxCallback public function Get extra field plugin ajax.
ExtraFieldTypePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ExtraFieldTypePluginBase::getEntityFieldReferenceTypes protected function Get entity field reference types.
ExtraFieldTypePluginBase::getEntityTokenData protected function Get entity token data.
ExtraFieldTypePluginBase::getEntityTokenTypes protected function Get entity token types.
ExtraFieldTypePluginBase::getPluginFormStateValue protected function Get plugin form state value.
ExtraFieldTypePluginBase::getTargetEntityTypeBundle protected function Get target entity type bundle.
ExtraFieldTypePluginBase::getTargetEntityTypeDefinition protected function Get target entity type definition.
ExtraFieldTypePluginBase::getTargetEntityTypeId protected function Get target entity type identifier.
ExtraFieldTypePluginBase::label public function Display the extra field plugin label. Overrides ExtraFieldTypePluginInterface::label
ExtraFieldTypePluginBase::processEntityToken protected function Process the entity token text.
ExtraFieldTypePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ExtraFieldTypePluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
ExtraFieldTypePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
ExtraFieldTypePluginBase::__construct public function Extra field type view constructor. Overrides PluginBase::__construct 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.
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
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.