X-Git-Url: http://www.aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Fentity_embed%2Fsrc%2FPlugin%2Fentity_embed%2FEntityEmbedDisplay%2FImageFieldFormatter.php;fp=web%2Fmodules%2Fcontrib%2Fentity_embed%2Fsrc%2FPlugin%2Fentity_embed%2FEntityEmbedDisplay%2FImageFieldFormatter.php;h=76b16413ec46163c78b5607d2ff2ab28b2eeab92;hb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;hp=0000000000000000000000000000000000000000;hpb=57c063afa3f66b07c4bbddc2d6129a96d90f0aad;p=yaffs-website

diff --git a/web/modules/contrib/entity_embed/src/Plugin/entity_embed/EntityEmbedDisplay/ImageFieldFormatter.php b/web/modules/contrib/entity_embed/src/Plugin/entity_embed/EntityEmbedDisplay/ImageFieldFormatter.php
new file mode 100644
index 000000000..76b16413e
--- /dev/null
+++ b/web/modules/contrib/entity_embed/src/Plugin/entity_embed/EntityEmbedDisplay/ImageFieldFormatter.php
@@ -0,0 +1,194 @@
+<?php
+
+namespace Drupal\entity_embed\Plugin\entity_embed\EntityEmbedDisplay;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Field\FormatterPluginManager;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Image\ImageFactory;
+use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\TypedData\TypedDataManager;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Entity Embed Display reusing image field formatters.
+ *
+ * @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface
+ *
+ * @EntityEmbedDisplay(
+ *   id = "image",
+ *   label = @Translation("Image"),
+ *   entity_types = {"file"},
+ *   deriver = "Drupal\entity_embed\Plugin\Derivative\FieldFormatterDeriver",
+ *   field_type = "image",
+ *   provider = "image"
+ * )
+ */
+class ImageFieldFormatter extends FileFieldFormatter {
+
+  /**
+   * The image factory.
+   *
+   * @var \Drupal\Core\Image\ImageFactory
+   */
+  protected $imageFactory;
+
+  /**
+   * {@inheritdoc}
+   *
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity manager service.
+   * @param \Drupal\Core\Field\FormatterPluginManager $formatter_plugin_manager
+   *   The field formatter plugin manager.
+   * @param \Drupal\Core\TypedData\TypedDataManager $typed_data_manager
+   *   The typed data manager.
+   * @param \Drupal\Core\Image\ImageFactory $image_factory
+   *   The image factory.
+   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+   *   The language manager.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, FormatterPluginManager $formatter_plugin_manager, TypedDataManager $typed_data_manager, ImageFactory $image_factory, LanguageManagerInterface $language_manager) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $formatter_plugin_manager, $typed_data_manager, $language_manager);
+    $this->imageFactory = $image_factory;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('entity_type.manager'),
+      $container->get('plugin.manager.field.formatter'),
+      $container->get('typed_data_manager'),
+      $container->get('image.factory'),
+      $container->get('language_manager')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFieldValue() {
+    $value = parent::getFieldValue();
+    // File field support descriptions, but images do not.
+    unset($value['description']);
+    $value += array_intersect_key($this->getAttributeValues(), array('alt' => '', 'title' => ''));
+    return $value;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function access(AccountInterface $account = NULL) {
+    return parent::access($account)->andIf($this->isValidImage());
+  }
+
+  /**
+   * Checks if the image is valid.
+   *
+   * @return \Drupal\Core\Access\AccessResult
+   *   Returns the access result.
+   */
+  protected function isValidImage() {
+    // If entity type is not file we have to return early to prevent fatal in
+    // the condition above. Access should already be forbidden at this point,
+    // which means this won't have any effect.
+    // @see EntityEmbedDisplayBase::access()
+    if ($this->getEntityTypeFromContext() != 'file') {
+      return AccessResult::forbidden();
+    }
+    $access = AccessResult::allowed();
+
+    // @todo needs cacheability metadata for getEntityFromContext.
+    // @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayBase::getEntityFromContext()
+    /** @var \Drupal\file\FileInterface $entity */
+    if ($entity = $this->getEntityFromContext()) {
+      // Loading large files is slow, make sure it is an image mime type before
+      // doing that.
+      list($type,) = explode('/', $entity->getMimeType(), 2);
+      $access = AccessResult::allowedIf($type == 'image' && $this->imageFactory->get($entity->getFileUri())->isValid())
+        // See the above @todo, this is the best we can do for now.
+        ->addCacheableDependency($entity);
+    }
+
+    return $access;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+    $form = parent::buildConfigurationForm($form, $form_state);
+
+    // File field support descriptions, but images do not.
+    unset($form['description']);
+
+    // Ensure that the 'Link image to: Content' setting is not available.
+    if ($this->getDerivativeId() == 'image') {
+      unset($form['image_link']['#options']['content']);
+    }
+
+    $entity_element = $form_state->get('entity_element');
+    // The alt attribute is *required*, but we allow users to opt-in to empty
+    // alt attributes for the very rare edge cases where that is valid by
+    // specifying two double quotes as the alternative text in the dialog.
+    // However, that *is* stored as an empty alt attribute, so if we're editing
+    // an existing image (which means the src attribute is set) and its alt
+    // attribute is empty, then we show that as two double quotes in the dialog.
+    // @see https://www.drupal.org/node/2307647
+    // Alt attribute behavior is taken from the Core image dialog to ensure a
+    // consistent UX across various forms.
+    // @see Drupal\editor\Form\EditorImageDialog::buildForm()
+    $alt = $this->getAttributeValue('alt', '');
+    if ($alt === '') {
+      // Do not change empty alt text to two double quotes if the previously
+      // used Entity Embed Display plugin was not 'image:image'. That means that
+      // some other plugin was used so if this image formatter is selected at a
+      // later stage, then this should be treated as a new edit. We show two
+      // double quotes in place of empty alt text only if that was filled
+      // intentionally by the user.
+      if (!empty($entity_element) && $entity_element['data-entity-embed-display'] == 'image:image') {
+        $alt = '""';
+      }
+    }
+
+    // Add support for editing the alternate and title text attributes.
+    $form['alt'] = array(
+      '#type' => 'textfield',
+      '#title' => $this->t('Alternate text'),
+      '#default_value' => $alt,
+      '#description' => $this->t('This text will be used by screen readers, search engines, or when the image cannot be loaded.'),
+      '#parents' => array('attributes', 'alt'),
+      '#required' => TRUE,
+      '#required_error' => $this->t('Alternative text is required.<br />(Only in rare cases should this be left empty. To create empty alternative text, enter <code>""</code> — two double quotes without any content).'),
+      '#maxlength' => 512,
+    );
+    $form['title'] = array(
+      '#type' => 'textfield',
+      '#title' => $this->t('Title'),
+      '#default_value' => $this->getAttributeValue('title', ''),
+      '#description' => t('The title is used as a tool tip when the user hovers the mouse over the image.'),
+      '#parents' => array('attributes', 'title'),
+      '#maxlength' => 1024,
+    );
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+    // When the alt attribute is set to two double quotes, transform it to the
+    // empty string: two double quotes signify "empty alt attribute". See above.
+    if (trim($form_state->getValue(array('attributes', 'alt'))) === '""') {
+      $form_state->setValue(array('attributes', 'alt'), '');
+    }
+  }
+
+}