foldershare-8.x-1.2/src/Ajax/OpenErrorDialogCommand.php

src/Ajax/OpenErrorDialogCommand.php
foldershare
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<?php
 
namespace Drupal\foldershare\Ajax;
 
use Drupal\Core\Ajax\OpenModalDialogCommand;
use Drupal\Core\Form\FormStateInterface;
 
use Drupal\foldershare\Constants;
 
/**
 * Defines an AJAX command to open a dialog and display error messages.
 *
 * This specialized AJAX dialog command creates a modal dialog with an
 * OK button to display a list of error messages. The dialog has a title,
 * an opening message, and a body that lists error messages. For a long
 * list, the body may include scrollbars.
 *
 * @ingroup foldershare
 */
class OpenErrorDialogCommand extends OpenModalDialogCommand {
 
  /*--------------------------------------------------------------------
   *
   * Construct.
   *
   *--------------------------------------------------------------------*/
 
  /**
   * Constructs an OpenDialogCommand object.
   *
   * @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 $dialogOptions
   *   (optional) Options 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(
    string $title,
    $content = '',
    array $dialogOptions = [],
    $settings = NULL) {
 
    if (empty($dialogOptions) === TRUE) {
      $dialogOptions = [
        'modal'             => TRUE,
        'draggable'         => FALSE,
        'resizable'         => FALSE,
        'refreshAfterClose' => FALSE,
        'closeOnEscape'     => TRUE,
        'closeText'         => t('Close'),
        'width'             => '75%',
        'drupalAutoButtons' => TRUE,
        'classes'           => [
          'ui-dialog'       => [
            'foldershare-ui-dialog',
          ],
        ],
      ];
    }
 
    $body = [
      '#attached'        => [
        'library'        => [
          Constants::LIBRARY_MODULE,
        ],
      ],
      '#attributes'      => [
        'class'          => [
          'foldershare-dialog',
        ],
      ],
      '#tree'            => TRUE,
 
      'messages'         => [
        '#type'          => 'container',
        '#weight'        => 0,
        '#attributes'    => [
          'class'        => [
            Constants::MODULE . '-error-dialog-body',
          ],
        ],
      ],
 
      'actions'          => [
        '#type'          => 'actions',
        '#weight'        => 1000,
        '#attributes'    => [
          'class'        => [
            // Mark the action button area as if it is in a form, even
            // though it is not. This is needed in order for Drupal's
            // dialog handling to recognize that there is an action button
            // area so that it will move it to the bottom of the dialog.
            'form-actions',
          ],
        ],
        'cancel'         => [
          // Even though the cancel button doesn't submit anything, we have
          // to mark it as a submit button in order for Drupal's dialog
          // handling to recognize that there is an action button area
          // in the dialog.
          '#type'        => 'submit',
          '#name'        => 'cancel',
          '#value'       => t('Cancel'),
          '#button_type' => 'primary',
          '#attributes'  => [
            'class'      => [
              // Marking the button with "dialog-cancel" marks the button as
              // a cancel button that simply closes the dialog, without sending
              // anything to the server.
              'dialog-cancel',
            ],
          ],
        ],
      ],
    ];
 
    if (empty($content) === FALSE) {
      $body['messages']['content'] = [
        '#markup' => $content,
        '#weight' => 0,
      ];
    }
 
    parent::__construct($title, $body, $dialogOptions, $settings);
  }
 
  /*--------------------------------------------------------------------
   *
   * Get/Set.
   *
   *--------------------------------------------------------------------*/
 
  /**
   * Sets dialog content based upon form state errors.
   *
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The form state who's error messages are used to set the dialog's
   *   body.
   * @param bool $clearErrors
   *   (optional, default = TRUE) When TRUE, clears the form errors after
   *   adding them to the dialog body. Default is TRUE.
   */
  public function setFromFormErrors(
    FormStateInterface &$formState,
    bool $clearErrors = TRUE) {
 
    // Loop through the errors and add them to the container.
    // Errors have already been translated.
    $body = $this->content;
    foreach ($formState->getErrors() as $error) {
      $body['messages'][] = [
        '#type'       => 'html_tag',
        '#tag'        => 'div',
        '#value'      => $error,
      ];
    }
 
    // Clear errors out of the form.
    if ($clearErrors === TRUE) {
      $formState->clearErrors();
    }
 
    $this->content = $body;
  }
 
  /**
   * Sets dialog content based upon page messages.
   *
   * @param array $messageTypes
   *   (optional) An array containing one or more of 'error', 'warning',
   *   and 'status' that indicates the types of messages to include.
   *   Messages are always added in (error, warning, status) order.
   *   A NULL or empty array means to include everything. Default is NULL.
   */
  public function setFromPageMessages(
    array $messageTypes = NULL) {
 
    // Determine which message types to include.
    if (empty($messageTypes) === TRUE) {
      // Include everything in (error, warning, status) order.
      $messageTypes = [
        'error',
        'warning',
        'status',
      ];
    }
    else {
      // Include named types in (error, warning, status) order.
      // Ignore any other type names.
      $e = [];
      foreach (['error', 'warning', 'status'] as $t) {
        if (in_array($t, $messageTypes) === TRUE) {
          $e[] = $t;
        }
      }
 
      $messageTypes = $e;
    }
 
    // Loop through the types and messages and add them to the container.
    // Messages have already been translated.
    $allMessagesByType = \Drupal::messenger()->all();
    $body = $this->content;
 
    foreach ($allMessagesByType as $mtype => $messages) {
      if (in_array($mtype, $messageTypes) === TRUE) {
        foreach ($messages as $message) {
          $body['messages'][] = [
            '#type'  => 'html_tag',
            '#tag'   => 'div',
            '#value' => $message,
          ];
        }
 
        \Drupal::messenger()->deleteByType($mtype);
      }
    }
 
    $this->content = $body;
  }
 
}
Главная | Обратная связь
You are here

foldershare-8.x-1.2/src/Ajax/OpenErrorDialogCommand.php
