class ImageShadowboxFormatter in Shadowbox 8

Plugin implementation of the 'image_shadowbox' formatter.

Plugin annotation


@FieldFormatter(
  id = "image_shadowbox",
  label = @Translation("Shadowbox"),
  field_types = {
    "image"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
    class \Drupal\image_shadowbox\Plugin\Field\FieldFormatter\ImageShadowboxFormatter

Expanded class hierarchy of ImageShadowboxFormatter

File

image_shadowbox/lib/Drupal/image_shadowbox/Plugin/Field/FieldFormatter/ImageShadowboxFormatter.php, line 24: Contains \Drupal\image_shadowbox\Plugin\field\formatter\ImageShadowboxFormatter.

Namespace

Drupal\image_shadowbox\Plugin\Field\FieldFormatter

View source

class ImageShadowboxFormatter extends ImageFormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'image_style' => '',
      'image_link' => '',
      'gallery' => '',
      'compact' => '',
      'title' => '',
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, array &$form_state) {
    $image_styles = image_style_options(FALSE);
    $element['image_style'] = array(
      '#title' => t('Image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
    );
    $element['image_link'] = array(
      '#title' => t('Link image to'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_link'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
    );
    $gallery_options = array(
      'page' => 'gallery page',
      'field' => 'gallery field page',
      'nid' => 'gallery entity',
      'field_nid' => 'gallery field entity',
    );
    $element['gallery'] = array(
      '#title' => t('gallery'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('gallery'),
      '#empty_option' => t('None (individual)'),
      '#options' => $gallery_options,
    );
    $element['compact'] = array(
      '#title' => t('compact'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('compact'),
    );
    $title_options = array(
      'title' => 'image title',
      'alt' => 'image alt',
      'node' => 'node title',
    );
    $element['title'] = array(
      '#title' => t('caption'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('title'),
      '#empty_option' => t('None'),
      '#options' => $title_options,
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $image_styles = image_style_options(FALSE);

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    $image_style_setting = $this
      ->getSetting('image_style');
    if (isset($image_styles[$image_style_setting])) {
      $summary[] = t('Image style: @style', array(
        '@style' => $image_styles[$image_style_setting],
      ));
    }
    else {
      $summary[] = t('Original image');
    }
    if (isset($image_styles[$this
      ->getSetting('image_link')])) {
      $summary[] = t('Linked to: @style', array(
        '@style' => $image_styles[$this
          ->getSetting('image_link')],
      ));
    }
    else {
      $summary[] = t('Linked to: Original image');
    }
    $gallery_options = array(
      'page' => 'gallery page',
      'field' => 'gallery field page',
      'nid' => 'gallery entity',
      'field_nid' => 'gallery field entity',
    );
    if (isset($gallery_options[$this
      ->getSetting('gallery')])) {
      $summary[] = t('as @gallery', array(
        '@gallery' => ($this
          ->getSetting('compact') ? 'compact ' : '') . $gallery_options[$this
          ->getSetting('gallery')],
      ));
    }
    $title_options = array(
      'title' => 'image title',
      'alt' => 'image alt',
      'node' => 'node title',
    );
    if (isset($title_options[$this
      ->getSetting('title')])) {
      $summary[] = t('with @title as caption', array(
        '@title' => $title_options[$this
          ->getSetting('title')],
      ));
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items) {
    $elements = array();
    $config = \Drupal::config('shadowbox.settings');
    $entity = $items
      ->getEntity();
    $shadowbox_enabled_path = _shadowbox_activation() && $config
      ->get('shadowbox_enabled');
    switch ($this
      ->getSetting('gallery')) {
      case 'page':
        $gallery_id = 'gallery';
        break;
      case 'field':
        $gallery_id = $items
          ->getName();
        break;
      case 'nid':
        $gallery_id = implode('-', array(
          $entity
            ->getEntityTypeId(),
          $entity
            ->id(),
        ));
        break;
      case 'field_nid':
        $gallery_id = implode('-', array(
          $entity
            ->getEntityTypeId(),
          $entity
            ->id(),
          $items
            ->getName(),
        ));
        break;
      default:
        $gallery_id = '';
        break;
    }
    $rel = $gallery_id != '' ? "shadowbox[{$gallery_id}]" : 'shadowbox';
    $class = $gallery_id != '' ? "sb-image sb-gallery sb-gallery-{$gallery_id}" : 'sb-image sb-individual';
    $compact = $this
      ->getSetting('compact');
    foreach ($items as $delta => $item) {
      if ($item->entity) {
        switch ($this
          ->getSetting('title')) {
          case 'alt':
            $title = $item->alt;
            break;
          case 'title':
            $title = $item->title;
            break;
          case 'node':
            $title = $items
              ->getEntity()
              ->label();
            break;
          default:
            $title = '';
            break;
        }
        $linked_style = $this
          ->getSetting('image_link');
        if ($linked_style) {
          $style = entity_load('image_style', $linked_style);
          $uri = $style
            ->buildUrl($item->entity
            ->getFileUri());
        }
        else {
          $uri = $item->entity
            ->getFileUri();
        }
        $shadowbox_thumbnail = array(
          '#theme' => 'shadowbox_thumbnail',
          '#path' => $item->entity
            ->getFileUri(),
          '#alt' => $item->alt,
          '#title' => $title,
          '#image_style' => $this
            ->getSetting('image_style'),
        );
        $elements[$delta] = array(
          '#theme' => 'shadowbox_formatter',
          '#innerHTML' => $delta == 0 || !$compact ? $shadowbox_thumbnail : '',
          '#title' => $title,
          '#url' => file_create_url($uri),
          '#rel' => $rel,
          '#class' => $class,
        );
        if ($shadowbox_enabled_path) {
          $elements[$delta]['#attached']['library'][] = 'shadowbox/shadowbox';
        }
      }
    }
    return $elements;
  }

}

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
EntityReferenceFormatterBase::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
FileFormatterBase::checkAccess	protected	function	Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad	protected	function	Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad	1
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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
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::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
ImageFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
ImageShadowboxFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ImageShadowboxFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ImageShadowboxFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ImageShadowboxFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.
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.	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.

You are here

class ImageShadowboxFormatter in Shadowbox 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation