You are here

Home » API reference » PhotoSwipe 3.x » PhotoswipeResponsiveFieldFormatter.php

class PhotoswipeResponsiveFieldFormatter in PhotoSwipe 3.x

Provides formatter that supports responsive image.

Plugin annotation


@FieldFormatter(
  id = "photoswipe_respoinsive_field_formatter",
  label = @Translation("Photoswipe Responsive"),
  field_types = {
    "entity_reference",
    "image"
  }
)

Hierarchy

Expanded class hierarchy of PhotoswipeResponsiveFieldFormatter

File

src/Plugin/Field/FieldFormatter/PhotoswipeResponsiveFieldFormatter.php, line 24

Namespace

Drupal\photoswipe\Plugin\Field\FieldFormatter
View source 
class PhotoswipeResponsiveFieldFormatter extends PhotoswipeFieldFormatter {

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityManager;

  /**
   * {@inheritDoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->entityManager = $container
      ->get('entity_type.manager');

    // Don't need to use "hidden" style for responsive images.
    $instance->includeHidden = FALSE;
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    foreach (Element::children($elements) as $child) {
      $elements[$child]['#theme'] = 'photoswipe_responsive_image_formatter';
    }
    return $elements;
  }

  /**
   * {@inheritDoc}
   */
  protected function getImageStyles() {
    $resp_image_store = $this->entityManager
      ->getStorage('responsive_image_style');
    $responsive_image_options = [];
    $responsive_image_styles = $resp_image_store
      ->loadMultiple();
    foreach ($responsive_image_styles as $machine_name => $responsive_image_style) {
      if ($responsive_image_style
        ->hasImageStyleMappings()) {
        $responsive_image_options[$machine_name] = $responsive_image_style
          ->label();
      }
    }
    return $responsive_image_options;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    $resp_style_id = $this
      ->getSetting('photoswipe_node_style');

    /** @var \Drupal\responsive_image\ResponsiveImageStyleInterface $style */
    if ($resp_style_id && ($style = ResponsiveImageStyle::load($resp_style_id))) {

      // Add the responsive image style as dependency.
      $dependencies[$style
        ->getConfigDependencyKey()][] = $style
        ->getConfigDependencyName();
    }
    if (!empty($this
      ->getSetting('photoswipe_node_style_first'))) {
      $resp_style_id = $this
        ->getSetting('photoswipe_node_style_first');

      /** @var \Drupal\responsive_image\ResponsiveImageStyleInterface $style */
      if ($resp_style_id && ($style = ResponsiveImageStyle::load($resp_style_id))) {

        // Add the responsive image style as dependency.
        $dependencies[$style
          ->getConfigDependencyKey()][] = $style
          ->getConfigDependencyName();
      }
    }
    $style_id = $this
      ->getSetting('photoswipe_image_style');

    /** @var \Drupal\image\ImageStyleInterface $style */
    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 static function isApplicable(FieldDefinitionInterface $field_definition) {
    return \Drupal::service('module_handler')
      ->moduleExists('responsive_image') ? parent::isApplicable($field_definition) : FALSE;
  }

}

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::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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
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::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct
PhotoswipeResponsiveFieldFormatter::$entityManager protected property Entity type manager.
PhotoswipeResponsiveFieldFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PhotoswipeFieldFormatter::calculateDependencies
PhotoswipeResponsiveFieldFormatter::create public static function Creates an instance of the plugin. Overrides PhotoswipeFieldFormatter::create
PhotoswipeResponsiveFieldFormatter::getImageStyles protected function Get default image styles. Overrides PhotoswipeFieldFormatter::getImageStyles
PhotoswipeResponsiveFieldFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
PhotoswipeResponsiveFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides PhotoswipeFieldFormatter::viewElements
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.