GeysirOpenModalDialogCommand.php in Geysir 8

Namespace

Drupal\geysir\Ajax

File

src/Ajax/GeysirOpenModalDialogCommand.php

<?php

namespace Drupal\geysir\Ajax;

use Drupal\Core\Ajax\OpenDialogCommand;

/**
 * Defines an AJAX command to open certain content in a modal dialog.
 *
 * @ingroup ajax
 *
 * @see \Drupal\Core\Ajax\OpenModalDialogCommand
 */
class GeysirOpenModalDialogCommand extends OpenDialogCommand {

  /**
   * The CSS identifier of the Geysir modal.
   */
  const MODAL_SELECTOR = '#geysir-modal';

  /**
   * Constructs an OpenModalDialog object.
   *
   * The modal dialog differs from the normal modal provided by
   * OpenDialogCommand in that a modal prevents other interactions on the page
   * until the modal has been completed. Drupal provides a built-in modal for
   * this purpose, so no selector needs to be provided.
   *
   * @param string $title
   *   The title of the dialog.
   * @param string|array $content
   *   The content that will be placed in the dialog, either a render array
   *   or an HTML string.
   * @param array $dialog_options
   *   (optional) Settings to be passed to the dialog implementation. Any
   *   jQuery UI option can be used. See http://api.jqueryui.com/dialog.
   * @param array|null $settings
   *   (optional) Custom settings that will be passed to the Drupal behaviors
   *   on the content of the dialog. If left empty, the settings will be
   *   populated automatically from the current request.
   */
  public function __construct($title, $content, array $dialog_options = [], $settings = NULL) {
    $default_dialog_options = [
      'dialogClass' => 'geysir-dialog',
      'width' => '60%',
      'modal' => TRUE,
    ];
    $dialog_options += $default_dialog_options;
    parent::__construct(self::MODAL_SELECTOR, $title, $content, $dialog_options, $settings);
  }

}

Classes

Name	Description
GeysirOpenModalDialogCommand	Defines an AJAX command to open certain content in a modal dialog.