You are here

Home » API reference » Colorbox field formatter 2.0.x » ColorboxFieldFormatter.php

class ColorboxFieldFormatter in Colorbox field formatter 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/ColorboxFieldFormatter.php \Drupal\colorbox_field_formatter\Plugin\Field\FieldFormatter\ColorboxFieldFormatter

Plugin implementation of the 'colorbox_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "colorbox_field_formatter",
  label = @Translation("Colorbox FF"),
  field_types = {
    "computed",
    "string"
  }
)

Hierarchy

Expanded class hierarchy of ColorboxFieldFormatter

File

src/Plugin/Field/FieldFormatter/ColorboxFieldFormatter.php, line 32

Namespace

Drupal\colorbox_field_formatter\Plugin\Field\FieldFormatter
View source 
class ColorboxFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * @var \Drupal\colorbox\ColorboxAttachment
   */
  protected $colorboxAttachment;

  /**
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * ColorboxFieldFormatter constructor.
   *
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   * @param array $settings
   * @param $label
   * @param $view_mode
   * @param array $third_party_settings
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   * @param \Drupal\colorbox\ColorboxAttachment $colorbox_attachment
   * @param \Drupal\Core\Utility\Token $token
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ModuleHandlerInterface $module_handler, ColorboxAttachment $colorbox_attachment, Token $token) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->moduleHandler = $module_handler;
    $this->colorboxAttachment = $colorbox_attachment;
    $this->token = $token;
  }

  /**
   * {@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('module_handler'), $container
      ->get('colorbox.attachment'), $container
      ->get('token'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'style' => 'default',
      'link_type' => 'content',
      'link' => '',
      'width' => '500',
      'height' => '500',
      'iframe' => 0,
      'inline_selector' => '',
      'anchor' => '',
      'class' => '',
      'rel' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['style'] = [
      '#title' => $this
        ->t('Style of colorbox'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('style'),
      '#options' => $this
        ->getStyles(),
      '#attributes' => [
        'class' => [
          'colorbox-field-formatter-style',
        ],
      ],
    ];
    $form['link_type'] = [
      '#title' => $this
        ->t('Link colorbox to'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('link_type'),
      '#options' => $this
        ->getLinkTypes(),
      '#attributes' => [
        'class' => [
          'colorbox-field-formatter-link-type',
        ],
      ],
      '#states' => [
        'visible' => [
          'select.colorbox-field-formatter-style' => [
            'value' => 'default',
          ],
        ],
      ],
    ];
    $form['link'] = [
      '#title' => $this
        ->t('URI'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link'),
      '#states' => [
        'visible' => [
          'select.colorbox-field-formatter-style' => [
            'value' => 'default',
          ],
          'select.colorbox-field-formatter-link-type' => [
            'value' => 'manual',
          ],
        ],
      ],
    ];
    if ($this->moduleHandler
      ->moduleExists('token') && ($buildInfo = $form_state
      ->getBuildInfo()) && ($callback_object = $buildInfo['callback_object']) && $callback_object instanceof EntityViewDisplayEditForm) {
      $form['token_help_wrapper'] = [
        '#type' => 'container',
        '#states' => [
          'visible' => [
            'select.colorbox-field-formatter-style' => [
              'value' => 'default',
            ],
            'select.colorbox-field-formatter-link-type' => [
              'value' => 'manual',
            ],
          ],
        ],
      ];
      $form['token_help_wrapper']['token_help'] = [
        '#theme' => 'token_tree_link',
        '#token_types' => [
          'entity' => $callback_object
            ->getEntity()
            ->getTargetEntityTypeId(),
        ],
        '#global_types' => TRUE,
      ];
    }
    $form['inline_selector'] = [
      '#title' => $this
        ->t('Inline selector'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('inline_selector'),
      '#states' => [
        'visible' => [
          'select.colorbox-field-formatter-style' => [
            'value' => 'colorbox-inline',
          ],
        ],
      ],
    ];
    $form['width'] = [
      '#title' => $this
        ->t('Width'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('width'),
    ];
    $form['height'] = [
      '#title' => $this
        ->t('Height'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('height'),
    ];
    $form['iframe'] = [
      '#title' => $this
        ->t('iFrame Mode'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('iframe'),
    ];
    $form['anchor'] = [
      '#title' => $this
        ->t('Anchor'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('anchor'),
    ];
    $form['class'] = [
      '#title' => $this
        ->t('Class'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('class'),
    ];
    $form['rel'] = [
      '#title' => $this
        ->t('Rel'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('rel'),
      '#description' => $this
        ->t('This can be used to identify a group for Colorbox to cycle through.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $styles = $this
      ->getStyles();
    $summary[] = $this
      ->t('Style: @style', [
      '@style' => $styles[$this
        ->getSetting('style')],
    ]);
    if ($this
      ->getSetting('style') === 'default') {
      $types = $this
        ->getLinkTypes();
      if ($this
        ->getSetting('link_type') === 'manual') {
        $summary[] = $this
          ->t('Link to @link', [
          '@link' => $this
            ->getSetting('link'),
        ]);
      }
      else {
        $summary[] = $this
          ->t('Link to @link', [
          '@link' => $types[$this
            ->getSetting('link_type')],
        ]);
      }
    }
    if ($this
      ->getSetting('style') === 'colorbox-inline') {
      $summary[] = $this
        ->t('Inline selector: @selector', [
        '@selector' => $this
          ->getSetting('inline_selector'),
      ]);
    }
    $summary[] = $this
      ->t('Width: @width', [
      '@width' => $this
        ->getSetting('width'),
    ]);
    $summary[] = $this
      ->t('Height: @height', [
      '@height' => $this
        ->getSetting('height'),
    ]);
    $summary[] = $this
      ->t('iFrame Mode: @mode', [
      '@mode' => $this
        ->getSetting('iframe') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if (!empty($this
      ->getSetting('anchor'))) {
      $summary[] = $this
        ->t('Anchor: #@anchor', [
        '@anchor' => $this
          ->getSetting('anchor'),
      ]);
    }
    if (!empty($this
      ->getSetting('class'))) {
      $summary[] = $this
        ->t('Classes: @class', [
        '@class' => $this
          ->getSetting('class'),
      ]);
    }
    if (!empty($this
      ->getSetting('rel'))) {
      $summary[] = $this
        ->t('Rel: @rel', [
        '@rel' => $this
          ->getSetting('rel'),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  public function viewElements(FieldItemListInterface $items, $langcode) : array {
    $element = [];
    foreach ($items as $delta => $item) {
      $output = $this
        ->viewValue($item);
      $url = $this
        ->getUrl($item);
      $options = [
        'html' => TRUE,
        'attributes' => [
          'class' => [
            'colorbox',
            $this
              ->getSetting('style'),
          ],
        ],
        'query' => [
          'width' => $this
            ->getSetting('width'),
          'height' => $this
            ->getSetting('height'),
        ],
      ];
      if ($this
        ->getSetting('iframe')) {
        $options['query']['iframe'] = 'true';
      }
      if (!empty($this
        ->getSetting('anchor'))) {
        $options['fragment'] = $this
          ->getSetting('anchor');
      }
      if (!empty($this
        ->getSetting('class'))) {
        $options['attributes']['class'] = array_merge($options['attributes']['class'], explode(' ', $this
          ->getSetting('class')));
      }
      if (!empty($this
        ->getSetting('rel'))) {
        $options['attributes']['rel'] = $this
          ->getSetting('rel');
      }
      if ($this
        ->getSetting('style') === 'colorbox-inline') {
        $colorbox_inline_attributes = [
          'data-colorbox-inline' => $this
            ->getSetting('inline_selector'),
          'data-width' => $this
            ->getSetting('width'),
          'data-height' => $this
            ->getSetting('height'),
        ];
        $options['attributes'] = array_merge($options['attributes'], $colorbox_inline_attributes);
      }
      $url
        ->setOptions($options);
      $link = Link::fromTextAndUrl($output, $url);
      $element[$delta] = $link
        ->toRenderable();
    }

    // Attach the Colorbox JS and CSS.
    if ($this->colorboxAttachment
      ->isApplicable()) {
      $this->colorboxAttachment
        ->attach($element);
    }
    return $element;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string|array
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {

    // The text value has no text format assigned to it, so the user input
    // should equal the output, including newlines.

    /** @noinspection PhpUndefinedFieldInspection */
    return nl2br(Html::escape($item->value));
  }

  /**
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return \Drupal\Core\Url
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  protected function getUrl(FieldItemInterface $item) : Url {
    $entity = $item
      ->getEntity();
    if ($this
      ->getSetting('link_type') === 'content') {
      return $entity
        ->toUrl();
    }
    $link = $this
      ->getSetting('link');
    if ($this->moduleHandler
      ->moduleExists('token')) {
      $link = $this->token
        ->replace($this
        ->getSetting('link'), [
        $entity
          ->getEntityTypeId() => $entity,
      ], [
        'clear' => TRUE,
      ]);
    }
    return Url::fromUserInput($link);
  }

  /**
   * Callback to provide an array for a select field containing all supported
   * colorbox styles.
   *
   * @return array
   */
  private function getStyles() : array {
    $styles = [
      'default' => $this
        ->t('Default'),
    ];
    if ($this->moduleHandler
      ->moduleExists('colorbox_inline')) {
      $styles['colorbox-inline'] = $this
        ->t('Colorbox inline');
    }
    if ($this->moduleHandler
      ->moduleExists('colorbox_node')) {
      $styles['colorbox-node'] = $this
        ->t('Colorbox node');
    }
    return $styles;
  }

  /**
   * Callback to provide an arry for a select field containing all link types.
   *
   * @return array
   */
  private function getLinkTypes() : array {
    return [
      'content' => $this
        ->t('Content'),
      'manual' => $this
        ->t('Manually provide a link'),
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ColorboxFieldFormatter::$colorboxAttachment protected property
ColorboxFieldFormatter::$moduleHandler protected property
ColorboxFieldFormatter::$token protected property
ColorboxFieldFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ColorboxFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
ColorboxFieldFormatter::getLinkTypes private function Callback to provide an arry for a select field containing all link types.
ColorboxFieldFormatter::getStyles private function Callback to provide an array for a select field containing all supported colorbox styles.
ColorboxFieldFormatter::getUrl protected function 1
ColorboxFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 2
ColorboxFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 1
ColorboxFieldFormatter::viewElements public function Overrides FormatterInterface::viewElements
ColorboxFieldFormatter::viewValue protected function Generate the output appropriate for one field item. 2
ColorboxFieldFormatter::__construct public function ColorboxFieldFormatter constructor. Overrides FormatterBase::__construct
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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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.