You are here

Home » API reference » Forward 4.x » ForwardLinkFormatter.php

class ForwardLinkFormatter in Forward 4.x

Same name and namespace in other branches
  1. 4.0.x src/Plugin/Field/FieldFormatter/ForwardLinkFormatter.php \Drupal\forward\Plugin\Field\FieldFormatter\ForwardLinkFormatter

Plugin implementation of the Forward Link formatter.

Plugin annotation


@FieldFormatter(
  id = "forward_link",
  label = @Translation("Forward Link"),
  field_types = {
    "forward"
  }
)

Hierarchy

Expanded class hierarchy of ForwardLinkFormatter

File

src/Plugin/Field/FieldFormatter/ForwardLinkFormatter.php, line 30

Namespace

Drupal\forward\Plugin\Field\FieldFormatter
View source 
class ForwardLinkFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The Forward link generation service.
   *
   * @var \Drupal\forward\Services\ForwardLinkGeneratorInterface
   */
  protected $linkGenerator;

  /**
   * Constructs a ForwardLinkFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\forward\Services\ForwardLinkGeneratorInterface $link_generator
   *   The Forward link generation service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ForwardLinkGeneratorInterface $link_generator) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->linkGenerator = $link_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('forward.link_generator'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'title' => t('Forward this [forward:entity-type] to a friend'),
      'style' => 2,
      'icon' => '',
      'nofollow' => TRUE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return \Drupal::currentUser()
      ->hasPermission('access forward');
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $settings = $this
      ->getSettings();
    $element['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#default_value' => $settings['title'],
      '#description' => $this
        ->t('Set the text of the Forward link title. Replacement tokens may be used.'),
      '#required' => TRUE,
    ];
    $element['style'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Style'),
      '#default_value' => $settings['style'],
      '#options' => [
        0 => $this
          ->t('Text only'),
        1 => $this
          ->t('Icon only'),
        2 => $this
          ->t('Icon and text'),
      ],
      '#description' => $this
        ->t('Select the visual style of the link.'),
    ];
    $element['icon'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path to custom icon'),
      '#default_value' => $settings['icon'],
      '#description' => $this
        ->t('The path to your custom link icon instead of the default icon. Example: sites/default/files/icon.png'),
      '#element_validate' => [
        [
          get_class($this),
          'validateIconPath',
        ],
      ],
    ];
    $element['nofollow'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add a nofollow tag to the Forward link'),
      '#default_value' => $settings['nofollow'],
    ];
    return $element;
  }

  /**
   * Ensure the custom icon path is valid if provided.
   *
   * @param array $element
   *   The validated element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of the form.
   */
  public static function validateIconPath(array $element, FormStateInterface $form_state) {
    $plugin_name = $form_state
      ->get('plugin_settings_edit');
    $key = [
      'fields',
      $plugin_name,
      'settings_edit_form',
      'settings',
      'icon',
    ];
    $icon = $form_state
      ->getValue($key);
    if ($icon) {
      $image = File::create();
      $image
        ->setFileUri($icon);
      $filename = \Drupal::service('file_system')
        ->basename($image
        ->getFileUri());
      $image
        ->setFilename($filename);
      $errors = file_validate_is_image($image);
      if (count($errors)) {
        $form_state
          ->setError($element, t('The specified icon is not a valid image. Please double check the path.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Title: %title', [
      '%title' => $this
        ->getSetting('title'),
    ]);
    switch ($this
      ->getSetting('style')) {
      case 0:
        $summary[] = $this
          ->t('Style: Text only');
        break;
      case 1:
        $summary[] = $this
          ->t('Style: Icon only');
        break;
      case 2:
        $summary[] = $this
          ->t('Style: Icon and text');
        break;
    }
    if ($this
      ->getSetting('style') && $this
      ->getSetting('icon')) {
      $summary[] = $this
        ->t('Icon: %icon', [
        '%icon' => $this
          ->getSetting('icon'),
      ]);
    }
    if ($this
      ->getSetting('nofollow')) {
      $summary[] = $this
        ->t('Tag: A nofollow tag is added to the link');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareView(array $entities_items) {
    foreach ($entities_items as $item) {

      // If the display field is empty, it means the edit widget
      // has never been used for this entity. In this case,
      // default to display the link.  The user can then edit
      // the entity and hide the link if needed.
      if ($item
        ->isEmpty()) {
        $display = TRUE;
        $item
          ->appendItem($display);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $settings = $this
      ->getSettings();
    foreach ($items as $delta => $item) {
      $display = $item
        ->get('display')
        ->getValue();

      // Render unless directed otherwise.
      if (!empty($display)) {
        $entity = $item
          ->getEntity();
        $elements[$delta] = $this->linkGenerator
          ->generate($entity, $settings);
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
ForwardLinkFormatter::$linkGenerator protected property The Forward link generation service.
ForwardLinkFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ForwardLinkFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ForwardLinkFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
ForwardLinkFormatter::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterBase::prepareView
ForwardLinkFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ForwardLinkFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ForwardLinkFormatter::validateIconPath public static function Ensure the custom icon path is valid if provided.
ForwardLinkFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ForwardLinkFormatter::__construct public function Constructs a ForwardLinkFormatter object. Overrides FormatterBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.