IFrame::__construct() - Code Metrics - Inspection of "Issue #2685237 by marcingy, slashrsm: Add the abil..." - drupal-media/entity_browser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-1.x ( 620b4e...a65196 )

by Janez

created 2016-03-11 12:45 UTC

IFrame::__construct() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	6

Duplication

Lines	7
Ratio	100 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
dl	7
loc	7
rs	9.4285
c	3
b	0
f	1
cc	1
eloc	6
nc	1
nop	8

How to fix Many Parameters

<?php

/**
 * Contains \Drupal\entity_browser\Plugin\EntityBrowser\Display\IFrame.
 */

namespace Drupal\entity_browser\Plugin\EntityBrowser\Display;

use Drupal\Component\Uuid\UuidInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Url;
use Drupal\entity_browser\DisplayBase;
use Drupal\entity_browser\DisplayRouterInterface;
use Drupal\entity_browser\Events\Events;
use Drupal\entity_browser\Events\RegisterJSCallbacks;
use Drupal\entity_browser\Events\AlterEntityBrowserDisplayData;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Drupal\Core\Path\CurrentPathStack;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\HttpFoundation\Request;
use Drupal\Core\Form\FormStateInterface;


/**
 * Presents entity browser in an iFrame.
 *
 * @EntityBrowserDisplay(
 *   id = "iframe",
 *   label = @Translation("iFrame"),
 *   description = @Translation("Displays entity browser in an iFrame."),
 *   uses_route = TRUE
 * )
 */
class IFrame extends DisplayBase implements DisplayRouterInterface {

  /**
   * Current route match service.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $currentRouteMatch;

  /**
   * UUID generator interface.
   *
   * @var \Drupal\Component\Uuid\UuidInterface
   */
  protected $uuidGenerator;

  /**
   * UIID string.
   *
   * @var string
   */
  protected $uuid = NULL;

  /**
   * Current path.
   *
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  protected $currentPath;

  /**
   * Current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * Constructs display plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   Event dispatcher service.
   * @param \Drupal\Core\Routing\RouteMatchInterface
   *   The currently active route match object.
   * @param \Drupal\Component\Uuid\UuidInterface
   *   UUID generator interface.
   * @param \Drupal\Core\Path\CurrentPathStack $current_path
   *   The current path.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EventDispatcherInterface $event_dispatcher, RouteMatchInterface $current_route_match, UuidInterface $uuid, Request $request, CurrentPathStack $current_path) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $event_dispatcher);
    $this->currentRouteMatch = $current_route_match;
    $this->uuidGenerator = $uuid;
    $this->request = $request;
    $this->currentPath = $current_path;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('event_dispatcher'),
      $container->get('current_route_match'),
      $container->get('uuid'),
      $container->get('request_stack')->getCurrentRequest(),
      $container->get('path.current')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return array(
      'width' => '650',
      'height' => '500',
      'link_text' => t('Select entities'),
      'auto_open' => FALSE,
    ) + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function displayEntityBrowser(FormStateInterface $form_state) {
    $uuid = $this->getUuid();
    /** @var \Drupal\entity_browser\Events\RegisterJSCallbacks $event */
    // TODO - $uuid is unused in this event but we need to pass it as
    // constructor expects it. See https://www.drupal.org/node/2600706 for more
    // info.
    $js_event_object = new RegisterJSCallbacks($this->configuration['entity_browser_id'], $uuid);
    $js_event_object->registerCallback('Drupal.entityBrowser.selectionCompleted');
    $callback_event = $this->eventDispatcher->dispatch(Events::REGISTER_JS_CALLBACKS, $js_event_object);
    $original_path = $this->currentPath->getPath();
    $data = [
      'query_parameters' => [
        'query' => [
          'uuid' => $uuid,
          'original_path' => $original_path,
        ],
      ],
      'attributes' => [
        'href' => '#browser',
        'class' => ['entity-browser-handle', 'entity-browser-iframe'],
        'data-uuid' => $uuid,
        'data-original-path' => $original_path,
      ],
    ];
    $event_object = new AlterEntityBrowserDisplayData($this->configuration['entity_browser_id'], $uuid, $this->getPluginDefinition(), $form_state, $data);
    $event = $this->eventDispatcher->dispatch(Events::ALTER_BROWSER_DISPLAY_DATA, $event_object);
    $data = $event->getData();
    return [
      '#theme_wrappers' => ['container'],
      'link' => [
        '#type' => 'html_tag',
        '#tag' => 'a',
        '#value' => $this->configuration['link_text'],
        '#attributes' => $data['attributes'],
        '#attached' => [
          'library' => ['entity_browser/iframe'],
          'drupalSettings' => [
            'entity_browser' => [
              'iframe' => [
                $uuid => [
                  'src' => Url::fromRoute('entity_browser.' . $this->configuration['entity_browser_id'], [], $data['query_parameters'])
                    ->toString(),
                  'width' => $this->configuration['width'],
                  'height' => $this->configuration['height'],
                  'js_callbacks' => $callback_event->getCallbacks(),
                  'entity_browser_id' => $this->configuration['entity_browser_id'],
                  'auto_open' => $this->configuration['auto_open'],
                ],
              ],
            ],
          ]
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function selectionCompleted(array $entities) {
    $this->entities = $entities;
    $this->eventDispatcher->addListener(KernelEvents::RESPONSE, [$this, 'propagateSelection']);
  }

  /**
   * KernelEvents::RESPONSE listener. Intercepts default response and injects
   * response that will trigger JS to propagate selected entities upstream.
   *
   * @param FilterResponseEvent $event
   *   Response event.
   */
  public function propagateSelection(FilterResponseEvent $event) {
    $render = [
      'labels' => [
        '#markup' => 'Labels: ' . implode(', ', array_map(function (EntityInterface $item) {return $item->label();}, $this->entities)),
        '#attached' => [
          'library' => ['entity_browser/iframe_selection'],
          'drupalSettings' => [
            'entity_browser' => [
              'iframe' => [
                'entities' => array_map(function (EntityInterface $item) {return [$item->id(), $item->uuid(), $item->getEntityTypeId()];}, $this->entities),
                'uuid' => $this->request->query->get('uuid'),
              ],
            ],
          ],
        ],
      ],
    ];

    $event->setResponse(new Response(\Drupal::service('bare_html_page_renderer')->renderBarePage($render, 'Entity browser', 'page')));
  }

  /**
   * {@inheritdoc}
   */
  public function getUuid() {
    if (empty($this->uuid)) {
      $this->uuid = $this->uuidGenerator->generate();
    }
    return $this->uuid;
  }

  /**
    * {@inheritdoc}
    */
  public function setUuid($uuid) {
    $this->uuid = $uuid;
  }

  /**
   * {@inheritdoc}
   */
  public function path() {
    return '/entity-browser/iframe/' . $this->configuration['entity_browser_id'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $configuration = $this->getConfiguration();
    $form['width'] = [
      '#type' => 'number',
      '#title' => $this->t('Width of the iFrame'),
      '#min' => 1,
      '#default_value' => $configuration['width'],
    ];

    $form['height'] = [
      '#type' => 'number',
      '#title' => $this->t('Height of the iFrame'),
      '#min' => 1,
      '#default_value' => $configuration['height'],
    ];

    $form['link_text'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Link text'),
      '#default_value' => $configuration['link_text'],
    ];

    $form['auto_open'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Auto open entity browser'),
      '#default_value' => $configuration['auto_open'],
    ];

    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state->getValue('width') <= 0) {
      $form_state->setError($form['width'], $this->t('Width must be greather than 0.'));
    }
    if ($form_state->getValue('height') <= 0) {
      $form_state->setError($form['height'], $this->t('Height must be greather than 0.'));
    }
  }

}


1			<?php
2
3			/**
4			* Contains \Drupal\entity_browser\Plugin\EntityBrowser\Display\IFrame.
5			*/
6
7			namespace Drupal\entity_browser\Plugin\EntityBrowser\Display;
8
9			use Drupal\Component\Uuid\UuidInterface;
10			use Drupal\Core\Entity\EntityInterface;
11			use Drupal\Core\Form\FormStateInterface;
12			use Drupal\Core\Routing\RouteMatchInterface;
13			use Drupal\Core\Url;
14			use Drupal\entity_browser\DisplayBase;
15			use Drupal\entity_browser\DisplayRouterInterface;
16			use Drupal\entity_browser\Events\Events;
17			use Drupal\entity_browser\Events\RegisterJSCallbacks;
18			use Drupal\entity_browser\Events\AlterEntityBrowserDisplayData;
19			use Symfony\Component\DependencyInjection\ContainerInterface;
20			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
21			use Drupal\Core\Path\CurrentPathStack;
22			use Symfony\Component\HttpFoundation\Response;
23			use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
24			use Symfony\Component\HttpKernel\KernelEvents;
25			use Symfony\Component\HttpFoundation\Request;
26			use Drupal\Core\Form\FormStateInterface;
			0 ignored issues – show Bug introduced 2016-03-10 22:10 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Cannot use Drupal\Core\Form\FormStateInterface as FormStateInterface because the name is already in use Loading history...
27
28			/**
29			* Presents entity browser in an iFrame.
30			*
31			* @EntityBrowserDisplay(
32			* id = "iframe",
33			* label = @Translation("iFrame"),
34			* description = @Translation("Displays entity browser in an iFrame."),
35			* uses_route = TRUE
36			* )
37			*/
38			class IFrame extends DisplayBase implements DisplayRouterInterface {
39
40			/**
41			* Current route match service.
42			*
43			* @var \Drupal\Core\Routing\RouteMatchInterface
44			*/
45			protected $currentRouteMatch;
46
47			/**
48			* UUID generator interface.
49			*
50			* @var \Drupal\Component\Uuid\UuidInterface
51			*/
52			protected $uuidGenerator;
53
54			/**
55			* UIID string.
56			*
57			* @var string
58			*/
59			protected $uuid = NULL;
60
61			/**
62			* Current path.
63			*
64			* @var \Drupal\Core\Path\CurrentPathStack
65			*/
66			protected $currentPath;
67
68			/**
69			* Current request.
70			*
71			* @var \Symfony\Component\HttpFoundation\Request
72			*/
73			protected $request;
74
75			/**
76			* Constructs display plugin.
77			*
78			* @param array $configuration
79			* A configuration array containing information about the plugin instance.
80			* @param string $plugin_id
81			* The plugin_id for the plugin instance.
82			* @param mixed $plugin_definition
83			* The plugin implementation definition.
84			* @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
85			* Event dispatcher service.
86			* @param \Drupal\Core\Routing\RouteMatchInterface
87			* The currently active route match object.
88			* @param \Drupal\Component\Uuid\UuidInterface
89			* UUID generator interface.
90			* @param \Drupal\Core\Path\CurrentPathStack $current_path
91			* The current path.
92			*/
93			public function __construct(array $configuration, $plugin_id, $plugin_definition, EventDispatcherInterface $event_dispatcher, RouteMatchInterface $current_route_match, UuidInterface $uuid, Request $request, CurrentPathStack $current_path) {
94			parent::__construct($configuration, $plugin_id, $plugin_definition, $event_dispatcher);
95			$this->currentRouteMatch = $current_route_match;
96			$this->uuidGenerator = $uuid;
97			$this->request = $request;
98			$this->currentPath = $current_path;
99			}
100
101			/**
102			* {@inheritdoc}
103			*/
104			public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
105			return new static(
106			$configuration,
107			$plugin_id,
108			$plugin_definition,
109			$container->get('event_dispatcher'),
110			$container->get('current_route_match'),
111			$container->get('uuid'),
112			$container->get('request_stack')->getCurrentRequest(),
113			$container->get('path.current')
114			);
115			}
116
117			/**
118			* {@inheritdoc}
119			*/
120			public function defaultConfiguration() {
121			return array(
122			'width' => '650',
123			'height' => '500',
124			'link_text' => t('Select entities'),
125			'auto_open' => FALSE,
126			) + parent::defaultConfiguration();
127			}
128
129			/**
130			* {@inheritdoc}
131			*/
132			public function displayEntityBrowser(FormStateInterface $form_state) {
133			$uuid = $this->getUuid();
134			/** @var \Drupal\entity_browser\Events\RegisterJSCallbacks $event */
135			// TODO - $uuid is unused in this event but we need to pass it as
136			// constructor expects it. See https://www.drupal.org/node/2600706 for more
137			// info.
138			$js_event_object = new RegisterJSCallbacks($this->configuration['entity_browser_id'], $uuid);
139			$js_event_object->registerCallback('Drupal.entityBrowser.selectionCompleted');
140			$callback_event = $this->eventDispatcher->dispatch(Events::REGISTER_JS_CALLBACKS, $js_event_object);
141			$original_path = $this->currentPath->getPath();
142			$data = [
143			'query_parameters' => [
144			'query' => [
145			'uuid' => $uuid,
146			'original_path' => $original_path,
147			],
148			],
149			'attributes' => [
150			'href' => '#browser',
151			'class' => ['entity-browser-handle', 'entity-browser-iframe'],
152			'data-uuid' => $uuid,
153			'data-original-path' => $original_path,
154			],
155			];
156			$event_object = new AlterEntityBrowserDisplayData($this->configuration['entity_browser_id'], $uuid, $this->getPluginDefinition(), $form_state, $data);
157			$event = $this->eventDispatcher->dispatch(Events::ALTER_BROWSER_DISPLAY_DATA, $event_object);
158			$data = $event->getData();
159			return [
160			'#theme_wrappers' => ['container'],
161			'link' => [
162			'#type' => 'html_tag',
163			'#tag' => 'a',
164			'#value' => $this->configuration['link_text'],
165			'#attributes' => $data['attributes'],
166			'#attached' => [
167			'library' => ['entity_browser/iframe'],
168			'drupalSettings' => [
169			'entity_browser' => [
170			'iframe' => [
171			$uuid => [
172			'src' => Url::fromRoute('entity_browser.' . $this->configuration['entity_browser_id'], [], $data['query_parameters'])
173			->toString(),
174			'width' => $this->configuration['width'],
175			'height' => $this->configuration['height'],
176			'js_callbacks' => $callback_event->getCallbacks(),
177			'entity_browser_id' => $this->configuration['entity_browser_id'],
178			'auto_open' => $this->configuration['auto_open'],
179			],
180			],
181			],
182			]
183			],
184			],
185			];
186			}
187
188			/**
189			* {@inheritdoc}
190			*/
191			public function selectionCompleted(array $entities) {
192			$this->entities = $entities;
193			$this->eventDispatcher->addListener(KernelEvents::RESPONSE, [$this, 'propagateSelection']);
194			}
195
196			/**
197			* KernelEvents::RESPONSE listener. Intercepts default response and injects
198			* response that will trigger JS to propagate selected entities upstream.
199			*
200			* @param FilterResponseEvent $event
201			* Response event.
202			*/
203			public function propagateSelection(FilterResponseEvent $event) {
204			$render = [
205			'labels' => [
206			'#markup' => 'Labels: ' . implode(', ', array_map(function (EntityInterface $item) {return $item->label();}, $this->entities)),
207			'#attached' => [
208			'library' => ['entity_browser/iframe_selection'],
209			'drupalSettings' => [
210			'entity_browser' => [
211			'iframe' => [
212			'entities' => array_map(function (EntityInterface $item) {return [$item->id(), $item->uuid(), $item->getEntityTypeId()];}, $this->entities),
213			'uuid' => $this->request->query->get('uuid'),
214			],
215			],
216			],
217			],
218			],
219			];
220
221			$event->setResponse(new Response(\Drupal::service('bare_html_page_renderer')->renderBarePage($render, 'Entity browser', 'page')));
222			}
223
224			/**
225			* {@inheritdoc}
226			*/
227			public function getUuid() {
228			if (empty($this->uuid)) {
229			$this->uuid = $this->uuidGenerator->generate();
230			}
231			return $this->uuid;
232			}
233
234			/**
235			* {@inheritdoc}
236			*/
237			public function setUuid($uuid) {
238			$this->uuid = $uuid;
239			}
240
241			/**
242			* {@inheritdoc}
243			*/
244			public function path() {
245			return '/entity-browser/iframe/' . $this->configuration['entity_browser_id'];
246			}
247
248			/**
249			* {@inheritdoc}
250			*/
251			public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
252			$configuration = $this->getConfiguration();
253			$form['width'] = [
254			'#type' => 'number',
255			'#title' => $this->t('Width of the iFrame'),
256			'#min' => 1,
257			'#default_value' => $configuration['width'],
258			];
259
260			$form['height'] = [
261			'#type' => 'number',
262			'#title' => $this->t('Height of the iFrame'),
263			'#min' => 1,
264			'#default_value' => $configuration['height'],
265			];
266
267			$form['link_text'] = [
268			'#type' => 'textfield',
269			'#title' => $this->t('Link text'),
270			'#default_value' => $configuration['link_text'],
271			];
272
273			$form['auto_open'] = [
274			'#type' => 'checkbox',
275			'#title' => $this->t('Auto open entity browser'),
276			'#default_value' => $configuration['auto_open'],
277			];
278
279			return $form;
280			}
281
282			/**
283			* {@inheritdoc}
284			*/
285			public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
286			if ($form_state->getValue('width') <= 0) {
287			$form_state->setError($form['width'], $this->t('Width must be greather than 0.'));
288			}
289			if ($form_state->getValue('height') <= 0) {
290			$form_state->setError($form['height'], $this->t('Height must be greather than 0.'));
291			}
292			}
293
294			}
295

drupal-media / entity_browser

Push — 8.x-1.x ( 620b4e...a65196 )

IFrame::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like