class HoverPreview in Hover Preview for ImageCache 8

Plugin implementation of the 'hover_preview' formatter.

Plugin annotation


@FieldFormatter(
  id = "hover_preview",
  label = @Translation("Hover Preview"),
  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\hover_preview\Plugin\Field\FieldFormatter\HoverPreview

Expanded class hierarchy of HoverPreview

File

src/Plugin/Field/FieldFormatter/HoverPreview.php, line 23

Namespace

Drupal\hover_preview\Plugin\Field\FieldFormatter

View source

class HoverPreview extends FormatterBase {

  /**
   * @var EntityInterface
   */
  protected $entity;

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $image_styles = image_style_options(FALSE);
    $form_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,
    );
    $link_types = array(
      'content' => t('Content'),
      'file' => t('File'),
    );
    $form_element['image_link'] = array(
      '#title' => t('Link image to'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_link'),
      '#empty_option' => t('Nothing'),
      '#options' => $link_types,
    );
    $form_element['hover_preview_action'] = array(
      '#title' => t('Hover preview action'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('hover_preview_action'),
      '#required' => TRUE,
      '#options' => array(
        'imgpreview' => t('Image Preview'),
        'replace' => t('Replace Image'),
      ),
    );
    $form_element['hover_preview_style'] = array(
      '#title' => t('Hover preview style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('hover_preview_style'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
    );
    return $form_element + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $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.
    if (isset($image_styles[$settings['image_style']])) {
      $summary[] = $this
        ->t('Image style: @style', array(
        '@style' => $image_styles[$settings['image_style']],
      ));
    }
    else {
      $summary[] = $this
        ->t('Original image');
    }
    $link_types = array(
      'content' => t('Linked to content'),
      'file' => t('Linked to file'),
    );

    // Display this setting only if image is linked.
    if (isset($link_types[$settings['image_link']])) {
      $summary[] = $link_types[$settings['image_link']];
    }

    // Add in the Hover Preview action.
    if (isset($settings['hover_preview_action']) && !empty($settings['hover_preview_action'])) {
      $summary[] = $this
        ->t('Hover preview action: @action', array(
        '@action' => $settings['hover_preview_action'],
      ));
    }
    else {
      $summary[] = $this
        ->t('Hover preview action: Preview Image');
    }

    // Display the Hover Preview image style.
    $image_styles = image_style_options(FALSE);
    if (isset($image_styles[$settings['hover_preview_style']])) {
      $summary[] = $this
        ->t('Hover preview style: @style', array(
        '@style' => $image_styles[$settings['hover_preview_style']],
      ));
    }
    else {
      $summary[] = $this
        ->t('Hover preview style: Original image');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = array();
    $settings = $this
      ->getSettings();
    $this->entity = $items
      ->getEntity();

    // Each hover preview item is created with an image element.
    foreach ($items as $delta => $item) {
      $target_id = $item
        ->get('target_id')
        ->getValue();
      $file = File::load($target_id);
      $file_uri = $file
        ->getFileUri();
      $element[$delta]['#theme'] = 'image';

      // The title tag.
      $title = $item
        ->get('title')
        ->getValue();
      if (!empty($title)) {
        $element[$delta]['#title'] = $title;
      }

      // The alt tag.
      $alt = $item
        ->get('alt')
        ->getValue();
      if (!empty($alt)) {
        $element[$delta]['#alt'] = $alt;
      }

      // The image path is contructed based on the image style.
      if (isset($settings['image_style']) && !empty($settings['image_style'])) {

        #$element[$delta]['#path'] = image_style_url($settings['image_style'], $$file_uri);
        $element[$delta]['#uri'] = ImageStyle::load($settings['image_style'])
          ->buildUrl($file_uri);
      }
      else {

        // If no image style is provided, we use the original image.
        $element[$delta]['#uri'] = $file_uri;
      }

      // The hover preview image style.
      if (isset($settings['hover_preview_style']) && !empty($settings['hover_preview_style'])) {
        $hover_uri = ImageStyle::load($settings['hover_preview_style'])
          ->buildUrl($file_uri);
        $element[$delta]['#attributes']['data-hover-preview'] = file_create_url($hover_uri);
      }
      else {

        // If no hover preview style is provided, we use the original image.
        $element[$delta]['#attributes']['data-hover-preview'] = file_create_url($file_uri);
      }

      // Provide the hover-preview class and the action (default is imgpreview).
      $action = isset($settings['hover_preview_action']) && !empty($settings['hover_preview_action']) ? $settings['hover_preview_action'] : 'imgpreview';
      $element[$delta]['#attributes']['class'][] = 'hover-preview-' . $action;
      $element[$delta]['#attributes']['class'][] = 'hover-preview';

      // Special use cases for certain hover preview actions.
      switch ($action) {

        // Image Preview requires the imgPreview library.
        case 'imgpreview':
          $element[$delta]['#attached']['library'][] = 'hover_preview/hover_preview.imgPreview';
          break;

        // Image Preview requires the imgPreview library.
        case 'replace':
          $element[$delta]['#attached']['library'][] = 'hover_preview/hover_preview.imghover';
          break;
      }

      // Check if the formatter involves a link.
      switch ($settings['image_link']) {
        case 'content':

          // Link directly to the entity content.
          $url = $this->entity
            ->toUrl();
          if ($url
            ->isExternal()) {
            $uri = $url
              ->getUri();
          }
          else {
            $uri = '/' . $url
              ->getInternalPath();
          }
          $element[$delta]['#prefix'] = '<a href="' . $uri . '">';
          $element[$delta]['#suffix'] = '</a>';
          break;
        case 'file':

          // Link directly to the file.
          $element[$delta]['#prefix'] = '<a href="' . file_create_url($file_uri) . '">';
          $element[$delta]['#suffix'] = '</a>';
          break;
      }

      // The Hover Preview module requires the JavaScript to load the behaviors.
      $element[$delta]['#attached']['library'][] = 'hover_preview/hover_preview.hover_preview';
    }
    return $element;
  }

}

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
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::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
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
HoverPreview::$entity	protected	property
HoverPreview::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
HoverPreview::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
HoverPreview::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
HoverPreview::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 HoverPreview in Hover Preview for ImageCache 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation