Blame view

vendor/yiisoft/yii2-bootstrap/Modal.php 7.59 KB
70f4f18b   Administrator   first_commit
1
2
3
4
5
6
7
8
9
10
11
  <?php
  /**
   * @link http://www.yiiframework.com/
   * @copyright Copyright (c) 2008 Yii Software LLC
   * @license http://www.yiiframework.com/license/
   */
  
  namespace yii\bootstrap;
  
  use Yii;
  use yii\helpers\ArrayHelper;
70f4f18b   Administrator   first_commit
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
  
  /**
   * Modal renders a modal window that can be toggled by clicking on a button.
   *
   * The following example will show the content enclosed between the [[begin()]]
   * and [[end()]] calls within the modal window:
   *
   * ~~~php
   * Modal::begin([
   *     'header' => '<h2>Hello world</h2>',
   *     'toggleButton' => ['label' => 'click me'],
   * ]);
   *
   * echo 'Say hello...';
   *
   * Modal::end();
   * ~~~
   *
   * @see http://getbootstrap.com/javascript/#modals
   * @author Antonio Ramirez <amigo.cobos@gmail.com>
   * @author Qiang Xue <qiang.xue@gmail.com>
   * @since 2.0
   */
  class Modal extends Widget
  {
      const SIZE_LARGE = "modal-lg";
      const SIZE_SMALL = "modal-sm";
      const SIZE_DEFAULT = "";
  
      /**
       * @var string the header content in the modal window.
       */
      public $header;
      /**
       * @var string additional header options
       * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
       * @since 2.0.1
       */
      public $headerOptions;
      /**
       * @var string the footer content in the modal window.
       */
      public $footer;
      /**
       * @var string additional footer options
       * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
       * @since 2.0.1
       */
      public $footerOptions;
      /**
       * @var string the modal size. Can be [[SIZE_LARGE]] or [[SIZE_SMALL]], or empty for default.
       */
      public $size;
      /**
       * @var array|false the options for rendering the close button tag.
       * The close button is displayed in the header of the modal window. Clicking
       * on the button will hide the modal window. If this is false, no close button will be rendered.
       *
       * The following special options are supported:
       *
       * - tag: string, the tag name of the button. Defaults to 'button'.
       * - label: string, the label of the button. Defaults to '&times;'.
       *
       * The rest of the options will be rendered as the HTML attributes of the button tag.
       * Please refer to the [Modal plugin help](http://getbootstrap.com/javascript/#modals)
       * for the supported HTML attributes.
       */
      public $closeButton = [];
      /**
       * @var array the options for rendering the toggle button tag.
       * The toggle button is used to toggle the visibility of the modal window.
       * If this property is false, no toggle button will be rendered.
       *
       * The following special options are supported:
       *
       * - tag: string, the tag name of the button. Defaults to 'button'.
       * - label: string, the label of the button. Defaults to 'Show'.
       *
       * The rest of the options will be rendered as the HTML attributes of the button tag.
       * Please refer to the [Modal plugin help](http://getbootstrap.com/javascript/#modals)
       * for the supported HTML attributes.
       */
      public $toggleButton = false;
  
  
      /**
       * Initializes the widget.
       */
      public function init()
      {
          parent::init();
  
          $this->initOptions();
  
          echo $this->renderToggleButton() . "\n";
          echo Html::beginTag('div', $this->options) . "\n";
          echo Html::beginTag('div', ['class' => 'modal-dialog ' . $this->size]) . "\n";
          echo Html::beginTag('div', ['class' => 'modal-content']) . "\n";
          echo $this->renderHeader() . "\n";
          echo $this->renderBodyBegin() . "\n";
      }
  
      /**
       * Renders the widget.
       */
      public function run()
      {
          echo "\n" . $this->renderBodyEnd();
          echo "\n" . $this->renderFooter();
          echo "\n" . Html::endTag('div'); // modal-content
          echo "\n" . Html::endTag('div'); // modal-dialog
          echo "\n" . Html::endTag('div');
  
          $this->registerPlugin('modal');
      }
  
      /**
       * Renders the header HTML markup of the modal
       * @return string the rendering result
       */
      protected function renderHeader()
      {
          $button = $this->renderCloseButton();
          if ($button !== null) {
              $this->header = $button . "\n" . $this->header;
          }
          if ($this->header !== null) {
bedb55fe   Mihail   fixed Image class
139
              Html::addCssClass($this->headerOptions, ['widget' => 'modal-header']);
70f4f18b   Administrator   first_commit
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
              return Html::tag('div', "\n" . $this->header . "\n", $this->headerOptions);
          } else {
              return null;
          }
      }
  
      /**
       * Renders the opening tag of the modal body.
       * @return string the rendering result
       */
      protected function renderBodyBegin()
      {
          return Html::beginTag('div', ['class' => 'modal-body']);
      }
  
      /**
       * Renders the closing tag of the modal body.
       * @return string the rendering result
       */
      protected function renderBodyEnd()
      {
          return Html::endTag('div');
      }
  
      /**
       * Renders the HTML markup for the footer of the modal
       * @return string the rendering result
       */
      protected function renderFooter()
      {
          if ($this->footer !== null) {
bedb55fe   Mihail   fixed Image class
171
              Html::addCssClass($this->footerOptions, ['widget' => 'modal-footer']);
70f4f18b   Administrator   first_commit
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
              return Html::tag('div', "\n" . $this->footer . "\n", $this->footerOptions);
          } else {
              return null;
          }
      }
  
      /**
       * Renders the toggle button.
       * @return string the rendering result
       */
      protected function renderToggleButton()
      {
          if (($toggleButton = $this->toggleButton) !== false) {
              $tag = ArrayHelper::remove($toggleButton, 'tag', 'button');
              $label = ArrayHelper::remove($toggleButton, 'label', 'Show');
              if ($tag === 'button' && !isset($toggleButton['type'])) {
                  $toggleButton['type'] = 'button';
              }
  
              return Html::tag($tag, $label, $toggleButton);
          } else {
              return null;
          }
      }
  
      /**
       * Renders the close button.
       * @return string the rendering result
       */
      protected function renderCloseButton()
      {
          if (($closeButton = $this->closeButton) !== false) {
              $tag = ArrayHelper::remove($closeButton, 'tag', 'button');
              $label = ArrayHelper::remove($closeButton, 'label', '&times;');
              if ($tag === 'button' && !isset($closeButton['type'])) {
                  $closeButton['type'] = 'button';
              }
  
              return Html::tag($tag, $label, $closeButton);
          } else {
              return null;
          }
      }
  
      /**
       * Initializes the widget options.
       * This method sets the default values for various options.
       */
      protected function initOptions()
      {
          $this->options = array_merge([
              'class' => 'fade',
              'role' => 'dialog',
              'tabindex' => -1,
          ], $this->options);
bedb55fe   Mihail   fixed Image class
227
          Html::addCssClass($this->options, ['widget' => 'modal']);
70f4f18b   Administrator   first_commit
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
  
          if ($this->clientOptions !== false) {
              $this->clientOptions = array_merge(['show' => false], $this->clientOptions);
          }
  
          if ($this->closeButton !== false) {
              $this->closeButton = array_merge([
                  'data-dismiss' => 'modal',
                  'aria-hidden' => 'true',
                  'class' => 'close',
              ], $this->closeButton);
          }
  
          if ($this->toggleButton !== false) {
              $this->toggleButton = array_merge([
                  'data-toggle' => 'modal',
              ], $this->toggleButton);
              if (!isset($this->toggleButton['data-target']) && !isset($this->toggleButton['href'])) {
                  $this->toggleButton['data-target'] = '#' . $this->options['id'];
              }
          }
      }
  }