class PhotoswipeFieldFormatter in PhotoSwipe 3.x

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldFormatter/PhotoswipeFieldFormatter.php \Drupal\photoswipe\Plugin\Field\FieldFormatter\PhotoswipeFieldFormatter
8 src/Plugin/Field/FieldFormatter/PhotoswipeFieldFormatter.php \Drupal\photoswipe\Plugin\Field\FieldFormatter\PhotoswipeFieldFormatter

Plugin implementation of the 'photoswipe_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "photoswipe_field_formatter",
  label = @Translation("Photoswipe"),
  field_types = {
    "entity_reference",
    "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\photoswipe\Plugin\Field\FieldFormatter\PhotoswipeFieldFormatter

Expanded class hierarchy of PhotoswipeFieldFormatter

File

src/Plugin/Field/FieldFormatter/PhotoswipeFieldFormatter.php, line 29

Namespace

Drupal\photoswipe\Plugin\Field\FieldFormatter

View source

class PhotoswipeFieldFormatter extends FormatterBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * The assets manager.
   *
   * @var \Drupal\photoswipe\PhotoswipeAssetsManagerInterface
   */
  protected $photoswipeAssetManager;

  /**
   * True if include 'hidden' style for images.
   *
   * @var bool
   */
  protected $includeHidden = TRUE;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'photoswipe_node_style_first' => '',
      'photoswipe_node_style' => '',
      'photoswipe_image_style' => '',
      'photoswipe_reference_image_field' => '',
      'photoswipe_caption' => '',
      'photoswipe_caption_custom' => '',
      'photoswipe_view_mode' => '',
    ] + parent::defaultSettings();
  }

  /**
   * Constructs a FormatterBase 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\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   * @param \Drupal\photoswipe\PhotoswipeAssetsManagerInterface $assets_manager
   *   The assets manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ModuleHandlerInterface $module_handler, EntityFieldManagerInterface $entity_field_manager, EntityRepositoryInterface $entity_repository, PhotoswipeAssetsManagerInterface $assets_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->fieldDefinition = $field_definition;
    $this->settings = $settings;
    $this->label = $label;
    $this->viewMode = $view_mode;
    $this->thirdPartySettings = $third_party_settings;
    $this->moduleHandler = $module_handler;
    $this->entityFieldManager = $entity_field_manager;
    $this->entityRepository = $entity_repository;
    $this->photoswipeAssetManager = $assets_manager;
  }

  /**
   * {@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('entity_field.manager'), $container
      ->get('entity.repository'), $container
      ->get('photoswipe.assets_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $image_styles_hide = $this->includeHidden ? $this
      ->getImageStyles() + [
      'hide' => $this
        ->t('Hide (do not display image)'),
    ] : $this
      ->getImageStyles();
    $element['photoswipe_node_style_first'] = [
      '#title' => $this
        ->t('Node image style for first image'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('photoswipe_node_style_first'),
      '#empty_option' => $this
        ->t('No special style.'),
      '#options' => $image_styles_hide,
      '#description' => $this
        ->t('Image style to use in the content for the first image.'),
    ];
    $element['photoswipe_node_style'] = [
      '#title' => $this
        ->t('Node image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('photoswipe_node_style'),
      '#empty_option' => $this
        ->t('None (original image)'),
      '#options' => $image_styles_hide,
      '#description' => $this
        ->t('Image style to use in the node.'),
    ];
    $element['photoswipe_image_style'] = [
      '#title' => $this
        ->t('Photoswipe image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('photoswipe_image_style'),
      '#empty_option' => $this
        ->t('None (original image)'),
      '#options' => $this
        ->getPhotoSwipeStyles(),
      '#description' => $this
        ->t('Image style to use in the Photoswipe.'),
    ];

    // Set our caption options.
    $caption_options = [
      'title' => $this
        ->t('Image title tag'),
      'alt' => $this
        ->t('Image alt tag'),
      'node_title' => $this
        ->t('Entity title'),
      'custom' => $this
        ->t('Custom (with tokens)'),
    ];
    $element = $this
      ->addEntityReferenceSettings($element);

    // Add the other parent entity fields as options.
    if (isset($form['#fields'])) {
      foreach ($form['#fields'] as $parent_field) {
        if ($parent_field != $this->fieldDefinition
          ->getName()) {
          $caption_options[$parent_field] = $parent_field;
        }
      }
    }
    $element['photoswipe_caption'] = [
      '#title' => $this
        ->t('Photoswipe image caption'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('photoswipe_caption'),
      '#options' => $caption_options,
      '#description' => $this
        ->t('Field that should be used for the caption.'),
    ];
    $element['photoswipe_caption_custom'] = [
      '#title' => $this
        ->t('Custom caption'),
      '#type' => 'textarea',
      '#default_value' => $this
        ->getSetting('photoswipe_caption_custom'),
      '#states' => [
        'visible' => [
          ':input[name$="[settings][photoswipe_caption]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    if ($this->moduleHandler
      ->moduleExists('token')) {
      $element['photoswipe_token_caption'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Replacement patterns'),
        '#theme' => 'token_tree_link',
        // A KLUDGE! Need to figure out current entity type.
        // in both entity display and views contexts.
        '#token_types' => [
          'file',
          'node',
        ],
        '#states' => [
          'visible' => [
            ':input[name$="[settings][photoswipe_caption]"]' => [
              'value' => 'custom',
            ],
          ],
        ],
      ];
    }
    else {
      $element['photoswipe_token_caption'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Replacement patterns'),
        '#description' => '<strong class="error">' . $this
          ->t('For token support the <a href="@token_url">token module</a> must be installed.', [
          '@token_url' => 'http://drupal.org/project/token',
        ]) . '</strong>',
        '#states' => [
          'visible' => [
            ':input[name$="[settings][photoswipe_caption]"]' => [
              'value' => 'custom',
            ],
          ],
        ],
      ];
    }

    // Add the current view mode so we can control view mode for node fields.
    $element['photoswipe_view_mode'] = [
      '#type' => 'hidden',
      '#value' => $this->viewMode,
    ];
    return $element + parent::settingsForm($form, $form_state);
  }

  /**
   * Get default image styles.
   *
   * @return array
   *   Image styles.
   */
  protected function getImageStyles() {
    return image_style_options(FALSE);
  }

  /**
   * Get image styles for the photoswipe.
   *
   * @return array
   *   Image styles.
   */
  protected function getPhotoSwipeStyles() {
    return image_style_options(FALSE);
  }

  /**
   * Adds extra settings related when dealing with an entity reference.
   *
   * @param array $element
   *   The settings form structure of this formatter.
   *
   * @return array
   *   The modified settings form structure of this formatter.
   */
  public function addEntityReferenceSettings(array $element) {
    if ($this->fieldDefinition
      ->getType() !== 'entity_reference') {
      return $element;
    }
    $target_type = $this->fieldDefinition
      ->getSetting('target_type');
    $target_bundles = $this->fieldDefinition
      ->getSetting('handler_settings')['target_bundles'];

    /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $fields */
    $fields = [];
    foreach ($target_bundles as $bundle) {
      $fields += $this->entityFieldManager
        ->getFieldDefinitions($target_type, $bundle);
    }
    $fields = array_filter($fields, function (FieldDefinitionInterface $field) {
      return $field
        ->getType() === 'image' && $field
        ->getName() !== 'thumbnail';
    });
    $field_options = [];
    foreach ($fields as $name => $field) {
      $field_options[$name] = $field
        ->getName();
    }
    $element['photoswipe_reference_image_field'] = [
      '#title' => $this
        ->t('Image field of the referenced entity'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('photoswipe_reference_image_field'),
      '#options' => $field_options,
      '#description' => $this
        ->t('Field that contains the image to be used.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $image_styles = $this
      ->getImageStyles();
    $photoswipe_styles = $this
      ->getPhotoSwipeStyles();

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

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    if (isset($image_styles[$this
      ->getSetting('photoswipe_node_style')])) {
      $summary[] = $this
        ->t('Node image style: @style', [
        '@style' => $image_styles[$this
          ->getSetting('photoswipe_node_style')],
      ]);
    }
    elseif ($this
      ->getSetting('photoswipe_node_style') == 'hide') {
      $summary[] = $this
        ->t('Node image style: Hide');
    }
    else {
      $summary[] = $this
        ->t('Node image style: Original image');
    }
    if (isset($image_styles[$this
      ->getSetting('photoswipe_node_style_first')])) {
      $summary[] = $this
        ->t('Node image style of first image: @style', [
        '@style' => $image_styles[$this
          ->getSetting('photoswipe_node_style_first')],
      ]);
    }
    elseif ($this
      ->getSetting('photoswipe_node_style_first') == 'hide') {
      $summary[] = $this
        ->t('Node image style of first image: Hide');
    }
    else {
      $summary[] = $this
        ->t('Node image style of first image: Original image');
    }
    if (isset($photoswipe_styles[$this
      ->getSetting('photoswipe_image_style')])) {
      $summary[] = $this
        ->t('Photoswipe image style: @style', [
        '@style' => $photoswipe_styles[$this
          ->getSetting('photoswipe_image_style')],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Photoswipe image style: Original image');
    }
    if ($this
      ->getSetting('photoswipe_reference_image_field')) {
      $summary[] = $this
        ->t('Referenced entity image field: @field', [
        '@field' => $this
          ->getSetting('photoswipe_reference_image_field'),
      ]);
    }
    if ($this
      ->getSetting('photoswipe_caption')) {
      $caption_options = [
        'alt' => $this
          ->t('Image alt tag'),
        'title' => $this
          ->t('Image title tag'),
        'node_title' => $this
          ->t('Entity title'),
        'custom' => $this
          ->t('Custom (with tokens)'),
      ];
      if (array_key_exists($this
        ->getSetting('photoswipe_caption'), $caption_options)) {
        $caption_setting = $caption_options[$this
          ->getSetting('photoswipe_caption')];
      }
      else {
        $caption_setting = $this
          ->getSetting('photoswipe_caption');
      }
      $summary[] = $this
        ->t('Photoswipe Caption: @field', [
        '@field' => $caption_setting,
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $settings = $this
      ->getSettings();
    if ($items
      ->isEmpty()) {
      $default_image = $this
        ->getFieldSetting('default_image');

      // If we are dealing with a configurable field, look in both
      // instance-level and field-level settings.
      if (empty($default_image['uuid']) && $this->fieldDefinition instanceof FieldConfigInterface) {
        $default_image = $this->fieldDefinition
          ->getFieldStorageDefinition()
          ->getSetting('default_image');
      }
      if (!empty($default_image['uuid']) && ($file = $this->entityRepository
        ->loadEntityByUuid('file', $default_image['uuid']))) {

        // Clone the FieldItemList into a runtime-only object for the formatter,
        // so that the fallback image can be rendered without affecting the
        // field values in the entity being rendered.
        $items = clone $items;
        $items
          ->setValue([
          'target_id' => $file
            ->id(),
          'alt' => $default_image['alt'],
          'title' => $default_image['title'],
          'width' => $default_image['width'],
          'height' => $default_image['height'],
          'entity' => $file,
          '_loaded' => TRUE,
          '_is_default' => TRUE,
        ]);
      }
    }
    $this->photoswipeAssetManager
      ->attach($elements);
    if (!empty($items) && count($items) > 1) {

      // If there are more than 1 elements, add the gallery wrapper.
      // Otherwise this is done in javascript for more flexibility.
      $elements['#prefix'] = '<div class="photoswipe-gallery">';
      $elements['#suffix'] = '</div>';
    }
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#theme' => 'photoswipe_image_formatter',
        '#item' => $item,
        '#entity' => $items
          ->getEntity(),
        '#display_settings' => $settings,
        '#delta' => $delta,
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    $style_ids = [];
    $style_ids[] = $this
      ->getSetting('photoswipe_node_style');
    if (!empty($this
      ->getSetting('photoswipe_node_style_first'))) {
      $style_ids[] = $this
        ->getSetting('photoswipe_node_style_first');
    }
    $style_ids[] = $this
      ->getSetting('photoswipe_image_style');

    /** @var \Drupal\image\ImageStyleInterface $style */
    foreach ($style_ids as $style_id) {
      if ($style_id && ($style = ImageStyle::load($style_id))) {

        // If this formatter uses a valid image style to display the image, add
        // the image style configuration entity as dependency of this formatter.
        $dependencies[$style
          ->getConfigDependencyKey()][] = $style
          ->getConfigDependencyName();
      }
    }
    return $dependencies;
  }

  /**
   * {@inheritdoc}
   */
  public function onDependencyRemoval(array $dependencies) {
    $changed = parent::onDependencyRemoval($dependencies);
    $style_ids = [];
    $style_ids['photoswipe_node_style'] = $this
      ->getSetting('photoswipe_node_style');
    if (!empty($this
      ->getSetting('photoswipe_node_style_first'))) {
      $style_ids['photoswipe_node_style_first'] = $this
        ->getSetting('photoswipe_node_style_first');
    }
    $style_ids['photoswipe_image_style'] = $this
      ->getSetting('photoswipe_image_style');

    /** @var \Drupal\image\ImageStyleInterface $style */
    foreach ($style_ids as $name => $style_id) {
      if ($style_id && ($style = ImageStyle::load($style_id))) {
        if (!empty($dependencies[$style
          ->getConfigDependencyKey()][$style
          ->getConfigDependencyName()])) {
          $replacement_id = $this->imageStyleStorage
            ->getReplacementId($style_id);

          // If a valid replacement has been provided in the storage, replace
          // the image style with the replacement and signal that the formatter
          // plugin settings were updated.
          if ($replacement_id && ImageStyle::load($replacement_id)) {
            $this
              ->setSetting($name, $replacement_id);
            $changed = TRUE;
          }
        }
      }
    }
    return $changed;
  }

}

Members

Name	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::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.
PhotoswipeFieldFormatter::$entityFieldManager	protected	property	The entity field manager.
PhotoswipeFieldFormatter::$entityRepository	protected	property	The entity repository.
PhotoswipeFieldFormatter::$includeHidden	protected	property	True if include 'hidden' style for images.
PhotoswipeFieldFormatter::$moduleHandler	protected	property	The module handler.
PhotoswipeFieldFormatter::$photoswipeAssetManager	protected	property	The assets manager.
PhotoswipeFieldFormatter::addEntityReferenceSettings	public	function	Adds extra settings related when dealing with an entity reference.
PhotoswipeFieldFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies	1
PhotoswipeFieldFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	1
PhotoswipeFieldFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
PhotoswipeFieldFormatter::getImageStyles	protected	function	Get default image styles.	1
PhotoswipeFieldFormatter::getPhotoSwipeStyles	protected	function	Get image styles for the photoswipe.
PhotoswipeFieldFormatter::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
PhotoswipeFieldFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
PhotoswipeFieldFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
PhotoswipeFieldFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements	1
PhotoswipeFieldFormatter::__construct	public	function	Constructs a FormatterBase object. Overrides FormatterBase::__construct
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::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::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.

You are here

class PhotoswipeFieldFormatter in PhotoSwipe 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation