class Bootstrap4Modal in Bootstrap 4 Modal 2.x

Presents entity browser in an Modal.

Plugin annotation

@EntityBrowserDisplay(
  id = "bootstrap4_modal",
  label = @Translation("Bootstrap 4 Modal"),
  description = @Translation("Displays the entity browser in bootstrap 4 modal window."),
  uses_route = TRUE
)

Hierarchy

• class \Drupal\bootstrap4_modal\Plugin\EntityBrowser\Display\Bootstrap4Modal extends \Drupal\entity_browser\Plugin\EntityBrowser\Display\Modal

File

src/Plugin/EntityBrowser/Display/Bootstrap4Modal.php, line 26

Namespace

Drupal\bootstrap4_modal\Plugin\EntityBrowser\Display

class Bootstrap4Modal extends Modal {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'modal_size' => '',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function displayEntityBrowser(array $element, FormStateInterface $form_state, array &$complete_form, array $persistent_data = []) {
    DisplayBase::displayEntityBrowser($element, $form_state, $complete_form, $persistent_data);
    $js_event_object = new RegisterJSCallbacks($this->configuration['entity_browser_id'], $this
      ->getUuid());
    $js_event_object
      ->registerCallback('Drupal.entityBrowser.selectionCompleted');
    $js_event = $this->eventDispatcher
      ->dispatch(Events::REGISTER_JS_CALLBACKS, $js_event_object);
    $original_path = $this->currentPath
      ->getPath();
    $data = [
      'query_parameters' => [
        'query' => [
          'uuid' => $this
            ->getUuid(),
          'original_path' => $original_path,
        ],
      ],
      'attributes' => [
        'data-uuid' => $this
          ->getUuid(),
      ],
    ];
    $event_object = new AlterEntityBrowserDisplayData($this->configuration['entity_browser_id'], $this
      ->getUuid(), $this
      ->getPluginDefinition(), $form_state, $data);
    $event = $this->eventDispatcher
      ->dispatch(Events::ALTER_BROWSER_DISPLAY_DATA, $event_object);
    $data = $event
      ->getData();
    return [
      '#theme_wrappers' => [
        'container',
      ],
      'path' => [
        '#type' => 'hidden',
        '#value' => Url::fromRoute('entity_browser.' . $this->configuration['entity_browser_id'], [], $data['query_parameters'])
          ->toString(),
      ],
      'open_modal' => [
        '#type' => 'submit',
        '#value' => $this
          ->t($this->configuration['link_text']),
        '#limit_validation_errors' => [],
        '#submit' => [],
        '#name' => implode('_', $element['#eb_parents']),
        '#ajax' => [
          'callback' => [
            $this,
            'openModal',
          ],
          'event' => 'click',
        ],
        '#executes_submit_callback' => FALSE,
        '#attributes' => $data['attributes'],
        '#attached' => [
          'library' => [
            'bootstrap4_modal/bs4_modal.entity_browser',
          ],
          'drupalSettings' => [
            'entity_browser' => [
              $this
                ->getUuid() => [
                'auto_open' => $this->configuration['auto_open'],
              ],
              'modal' => [
                $this
                  ->getUuid() => [
                  'uuid' => $this
                    ->getUuid(),
                  'js_callbacks' => $js_event
                    ->getCallbacks(),
                  'original_path' => $original_path,
                  'auto_open' => $this->configuration['auto_open'],
                ],
              ],
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * Generates the content and opens the modal.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   An ajax response.
   */
  public function openModal(array &$form, FormStateInterface $form_state) {
    $triggering_element = $form_state
      ->getTriggeringElement();
    $parents = $triggering_element['#parents'];
    array_pop($parents);
    $parents = array_merge($parents, [
      'path',
    ]);
    $input = $form_state
      ->getUserInput();
    $src = NestedArray::getValue($input, $parents);
    $element_name = $this->configuration['entity_browser_id'];
    $name = 'entity_browser_iframe_' . $element_name;
    $content = [
      '#prefix' => '<div class="ajax-progress-throbber"></div>',
      '#type' => 'html_tag',
      '#tag' => 'iframe',
      '#attributes' => [
        'src' => $src,
        'class' => 'entity-browser-modal-iframe',
        'width' => '100%',
        'frameborder' => 0,
        'style' => 'padding:0; position:relative; z-index:10002;',
        'name' => $name,
        'id' => $name,
      ],
    ];
    $html = $this->renderer
      ->render($content);
    $title = $this
      ->t($this->configuration['link_text']);
    $options = [
      'dialogClasses' => [],
      'options' => [
        'fluid' => TRUE,
      ],
    ];
    $dialogClasses = [];
    if (!empty($this->configuration['modal_size'])) {
      $dialogClasses[] = $this->configuration['modal_size'];
    }
    $options['dialogClasses'] = implode(' ', $dialogClasses);
    $response = new AjaxResponse();
    $response
      ->addCommand(new OpenBootstrap4ModalDialogCommand($title, $html, $options));
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function __sleep() {
    return [
      'configuration',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $configuration = $this
      ->getConfiguration();
    $form = parent::buildConfigurationForm($form, $form_state);
    unset($form['width']);
    unset($form['height']);
    $form['modal_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Width of the modal'),
      '#default_value' => isset($configuration['modal_size']) ? $configuration['modal_size'] : NULL,
      '#options' => [
        'modal-sm' => $this
          ->t('Small'),
        '' => $this
          ->t('Default'),
        'modal-lg' => $this
          ->t('Large'),
        'modal-xl' => $this
          ->t('Extra large'),
      ],
    ];
    $form['auto_open']['#description'] = $this
      ->t('Will open Entity browser modal as soon as page is loaded, which might cause unwanted results. Should be used only in very specific cases such as Inline entity form integration. It is also advised not to use Entity browsers with this option enabled more than once per page.');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Bootstrap4Modal::buildConfigurationForm	public	function
Bootstrap4Modal::defaultConfiguration	public	function
Bootstrap4Modal::displayEntityBrowser	public	function
Bootstrap4Modal::openModal	public	function	Generates the content and opens the modal.
Bootstrap4Modal::validateConfigurationForm	public	function
Bootstrap4Modal::__sleep	public	function