class ImageExportFormatter in REST Views 8

Same name and namespace in other branches

2.0.x src/Plugin/Field/FieldFormatter/ImageExportFormatter.php \Drupal\rest_views\Plugin\Field\FieldFormatter\ImageExportFormatter

Process an image through an image style, and render the URL.

Plugin annotation


@FieldFormatter(
  id = "image_export",
  label = @Translation("Export image"),
  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\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
    class \Drupal\rest_views\Plugin\Field\FieldFormatter\ImageExportFormatter

Expanded class hierarchy of ImageExportFormatter

File

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

Namespace

Drupal\rest_views\Plugin\Field\FieldFormatter

View source

class ImageExportFormatter extends ImageFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = [
      'export_alt' => FALSE,
      'export_title' => FALSE,
    ] + parent::defaultSettings();
    unset($settings['image_link']);
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    unset($form['image_link']);
    $alt = $this
      ->getFieldSetting('alt_field');
    $title = $this
      ->getFieldSetting('title_field');
    if ($alt) {
      $form['export_alt'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Export <em>Alt</em> field'),
        '#description' => $this
          ->t('Enabling this will export an object instead of a string.'),
        '#default_value' => $this
          ->getSetting('export_alt'),
      ];
    }
    else {
      $form['export_alt'] = [
        '#type' => 'value',
        '#value' => FALSE,
      ];
    }
    if ($title) {
      $form['export_title'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Export <em>Title</em> field'),
        '#description' => $this
          ->t('Enabling this will export an object instead of a string.'),
        '#default_value' => $this
          ->getSetting('export_title'),
      ];
    }
    else {
      $form['export_title'] = [
        '#type' => 'value',
        '#value' => FALSE,
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($this
      ->getSetting('export_alt')) {
      $summary[] = $this
        ->t('<em>Alt</em> field is exported.');
    }
    if ($this
      ->getSetting('export_title')) {
      $summary[] = $this
        ->t('<em>Title</em> field is exported.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $alt = $this
      ->getSetting('export_alt');
    $title = $this
      ->getSetting('export_title');
    foreach ($elements as $delta => $element) {
      $item = $element['#item'];
      if (($entity = $item->entity) && empty($item->uri)) {

        /** @var \Drupal\file\FileInterface $entity */
        $uri = $entity
          ->getFileUri();
      }
      else {
        $uri = $item->uri;
      }
      if ($element['#image_style']) {

        /** @var \Drupal\image\ImageStyleInterface $style */
        $style = ImageStyle::load($element['#image_style']);

        // Determine the dimensions of the styled image.
        $dimensions = [
          'width' => $item->width,
          'height' => $item->height,
        ];
        $style
          ->transformDimensions($dimensions, $uri);
        $uri = $style
          ->buildUrl($uri);
      }
      else {
        $uri = file_create_url($uri);
      }
      if ($alt || $title) {
        $data = [
          'url' => $uri,
        ];
        if ($alt) {
          $data['alt'] = $item->alt;
        }
        if ($title && Unicode::strlen($item->title) > 0) {
          $data['title'] = $item->title;
        }
        $elements[$delta] = [
          '#type' => 'data',
          '#data' => SerializedData::create($data),
        ];
      }
      else {
        $elements[$delta] = [
          '#markup' => $uri,
        ];
      }
    }
    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::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
ImageExportFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
ImageExportFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
ImageExportFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
ImageExportFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
ImageFormatter::$currentUser	protected	property	The current user.
ImageFormatter::$imageStyleStorage	protected	property	The image style entity storage.
ImageFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	1
ImageFormatter::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct	public	function	Constructs an ImageFormatter object. Overrides FormatterBase::__construct	1
ImageFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
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::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.	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 ImageExportFormatter in REST Views 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation