ImageFieldFormatter::buildConfigurationForm() - Code Metrics - drupal-media/entity_embed - Measure and Improve Code Quality continuously with Scrutinizer

ImageFieldFormatter::buildConfigurationForm() B
last analyzed 2017-03-29 03:09 UTC

↳ Parent: ImageFieldFormatter

Complexity

Conditions	5
Paths	6

Size

Total Lines	57
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	27
nc	6
nop	2
dl	0
loc	57
rs	8.7433
c	0
b	0
f	0

How to fix Long Method

<?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'), '');
    }
  }

}


1		<?php
2
3		namespace Drupal\entity_embed\Plugin\entity_embed\EntityEmbedDisplay;
4
5		use Drupal\Core\Access\AccessResult;
6		use Drupal\Core\Entity\EntityTypeManagerInterface;
7		use Drupal\Core\Field\FormatterPluginManager;
8		use Drupal\Core\Form\FormStateInterface;
9		use Drupal\Core\Image\ImageFactory;
10		use Drupal\Core\Language\LanguageManagerInterface;
11		use Drupal\Core\Session\AccountInterface;
12		use Drupal\Core\TypedData\TypedDataManager;
13		use Symfony\Component\DependencyInjection\ContainerInterface;
14
15		/**
16		* Entity Embed Display reusing image field formatters.
17		*
18		* @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface
19		*
20		* @EntityEmbedDisplay(
21		* id = "image",
22		* label = @Translation("Image"),
23		* entity_types = {"file"},
24		* deriver = "Drupal\entity_embed\Plugin\Derivative\FieldFormatterDeriver",
25		* field_type = "image",
26		* provider = "image"
27		* )
28		*/
29		class ImageFieldFormatter extends FileFieldFormatter {
30
31		/**
32		* The image factory.
33		*
34		* @var \Drupal\Core\Image\ImageFactory
35		*/
36		protected $imageFactory;
37
38		/**
39		* {@inheritdoc}
40		*
41		* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
42		* The entity manager service.
43		* @param \Drupal\Core\Field\FormatterPluginManager $formatter_plugin_manager
44		* The field formatter plugin manager.
45		* @param \Drupal\Core\TypedData\TypedDataManager $typed_data_manager
46		* The typed data manager.
47		* @param \Drupal\Core\Image\ImageFactory $image_factory
48		* The image factory.
49		* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
50		* The language manager.
51		*/
52		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) {
53		parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $formatter_plugin_manager, $typed_data_manager, $language_manager);
54		$this->imageFactory = $image_factory;
55		}
56
57		/**
58		* {@inheritdoc}
59		*/
60	View Code Duplication	public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
		0 ignored issues – show Duplication introduced 2015-11-30 21:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61		return new static(
62		$configuration,
63		$plugin_id,
64		$plugin_definition,
65		$container->get('entity_type.manager'),
66		$container->get('plugin.manager.field.formatter'),
67		$container->get('typed_data_manager'),
68		$container->get('image.factory'),
69		$container->get('language_manager')
70		);
71		}
72
73		/**
74		* {@inheritdoc}
75		*/
76		public function getFieldValue() {
77		$value = parent::getFieldValue();
78		// File field support descriptions, but images do not.
79		unset($value['description']);
80		$value += array_intersect_key($this->getAttributeValues(), array('alt' => '', 'title' => ''));
81		return $value;
82		}
83
84		/**
85		* {@inheritdoc}
86		*/
87		public function access(AccountInterface $account = NULL) {
88		return parent::access($account)->andIf($this->isValidImage());
89		}
90
91		/**
92		* Checks if the image is valid.
93		*
94		* @return \Drupal\Core\Access\AccessResult
95		* Returns the access result.
96		*/
97		protected function isValidImage() {
98		// If entity type is not file we have to return early to prevent fatal in
99		// the condition above. Access should already be forbidden at this point,
100		// which means this won't have any effect.
101		// @see EntityEmbedDisplayBase::access()
102		if ($this->getEntityTypeFromContext() != 'file') {
103		return AccessResult::forbidden();
104		}
105		$access = AccessResult::allowed();
106
107		// @todo needs cacheability metadata for getEntityFromContext.
108		// @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayBase::getEntityFromContext()
109		/** @var \Drupal\file\FileInterface $entity */
110		if ($entity = $this->getEntityFromContext()) {
111		// Loading large files is slow, make sure it is an image mime type before
112		// doing that.
113		list($type,) = explode('/', $entity->getMimeType(), 2);
114		$access = AccessResult::allowedIf($type == 'image' && $this->imageFactory->get($entity->getFileUri())->isValid())
115		// See the above @todo, this is the best we can do for now.
116		->addCacheableDependency($entity);
117		}
118
119		return $access;
120		}
121
122		/**
123		* {@inheritdoc}
124		*/
125		public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
126		$form = parent::buildConfigurationForm($form, $form_state);
127
128		// File field support descriptions, but images do not.
129		unset($form['description']);
130
131		// Ensure that the 'Link image to: Content' setting is not available.
132		if ($this->getDerivativeId() == 'image') {
133		unset($form['image_link']['#options']['content']);
134		}
135
136		$entity_element = $form_state->get('entity_element');
137		// The alt attribute is required, but we allow users to opt-in to empty
138		// alt attributes for the very rare edge cases where that is valid by
139		// specifying two double quotes as the alternative text in the dialog.
140		// However, that is stored as an empty alt attribute, so if we're editing
141		// an existing image (which means the src attribute is set) and its alt
142		// attribute is empty, then we show that as two double quotes in the dialog.
143		// @see https://www.drupal.org/node/2307647
144		// Alt attribute behavior is taken from the Core image dialog to ensure a
145		// consistent UX across various forms.
146		// @see Drupal\editor\Form\EditorImageDialog::buildForm()
147		$alt = $this->getAttributeValue('alt', '');
148		if ($alt === '') {
149		// Do not change empty alt text to two double quotes if the previously
150		// used Entity Embed Display plugin was not 'image:image'. That means that
151		// some other plugin was used so if this image formatter is selected at a
152		// later stage, then this should be treated as a new edit. We show two
153		// double quotes in place of empty alt text only if that was filled
154		// intentionally by the user.
155		if (!empty($entity_element) && $entity_element['data-entity-embed-display'] == 'image:image') {
156		$alt = '""';
157		}
158		}
159
160		// Add support for editing the alternate and title text attributes.
161		$form['alt'] = array(
162		'#type' => 'textfield',
163		'#title' => $this->t('Alternate text'),
164		'#default_value' => $alt,
165		'#description' => $this->t('This text will be used by screen readers, search engines, or when the image cannot be loaded.'),
166		'#parents' => array('attributes', 'alt'),
167		'#required' => TRUE,
168		'#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).'),
169		'#maxlength' => 512,
170		);
171		$form['title'] = array(
172		'#type' => 'textfield',
173		'#title' => $this->t('Title'),
174		'#default_value' => $this->getAttributeValue('title', ''),
175		'#description' => t('The title is used as a tool tip when the user hovers the mouse over the image.'),
176		'#parents' => array('attributes', 'title'),
177		'#maxlength' => 1024,
178		);
179
180		return $form;
181		}
182
183		/**
184		* {@inheritdoc}
185		*/
186		public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
187		// When the alt attribute is set to two double quotes, transform it to the
188		// empty string: two double quotes signify "empty alt attribute". See above.
189		if (trim($form_state->getValue(array('attributes', 'alt'))) === '""') {
190		$form_state->setValue(array('attributes', 'alt'), '');
191		}
192		}
193
194		}
195

drupal-media / entity_embed

ImageFieldFormatter::buildConfigurationForm() B last analyzed 2017-03-29 03:09 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ImageFieldFormatter::buildConfigurationForm() B
last analyzed 2017-03-29 03:09 UTC