Blame view

vendor/yiisoft/yii2-bootstrap/Collapse.php 5.84 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\base\InvalidConfigException;
  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
  
  /**
   * Collapse renders an accordion bootstrap javascript component.
   *
   * For example:
   *
   * ```php
   * echo Collapse::widget([
   *     'items' => [
   *         // equivalent to the above
   *         [
   *             'label' => 'Collapsible Group Item #1',
   *             'content' => 'Anim pariatur cliche...',
   *             // open its content by default
   *             'contentOptions' => ['class' => 'in']
   *         ],
   *         // another group item
   *         [
   *             'label' => 'Collapsible Group Item #1',
   *             'content' => 'Anim pariatur cliche...',
   *             'contentOptions' => [...],
   *             'options' => [...],
   *         ],
   *         // if you want to swap out .panel-body with .list-group, you may use the following
   *         [
   *             'label' => 'Collapsible Group Item #1',
   *             'content' => [
   *                 'Anim pariatur cliche...',
   *                 'Anim pariatur cliche...'
   *             ],
   *             'contentOptions' => [...],
   *             'options' => [...],
   *             'footer' => 'Footer' // the footer label in list-group
   *         ],
   *     ]
   * ]);
   * ```
   *
   * @see http://getbootstrap.com/javascript/#collapse
   * @author Antonio Ramirez <amigo.cobos@gmail.com>
   * @since 2.0
   */
  class Collapse extends Widget
  {
      /**
       * @var array list of groups in the collapse widget. Each array element represents a single
       * group with the following structure:
       *
       * - label: string, required, the group header label.
       * - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
       *   global `$this->encodeLabels` param.
bedb55fe   Mihail   fixed Image class
63
       * - content: array|string|object, required, the content (HTML) of the group
70f4f18b   Administrator   first_commit
64
65
66
67
       * - options: array, optional, the HTML attributes of the group
       * - contentOptions: optional, the HTML attributes of the group's content
       */
      public $items = [];
70f4f18b   Administrator   first_commit
68
69
70
71
72
73
74
75
76
77
78
79
      /**
       * @var boolean whether the labels for header items should be HTML-encoded.
       */
      public $encodeLabels = true;
  
  
      /**
       * Initializes the widget.
       */
      public function init()
      {
          parent::init();
bedb55fe   Mihail   fixed Image class
80
          Html::addCssClass($this->options, ['widget' => 'panel-group']);
70f4f18b   Administrator   first_commit
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
      }
  
      /**
       * Renders the widget.
       */
      public function run()
      {
          $this->registerPlugin('collapse');
          return implode("\n", [
              Html::beginTag('div', $this->options),
              $this->renderItems(),
              Html::endTag('div')
          ]) . "\n";
      }
  
      /**
       * Renders collapsible items as specified on [[items]].
       * @throws InvalidConfigException if label isn't specified
       * @return string the rendering result
       */
      public function renderItems()
      {
          $items = [];
          $index = 0;
          foreach ($this->items as $item) {
              if (!array_key_exists('label', $item)) {
                  throw new InvalidConfigException("The 'label' option is required.");
              }
              $header = $item['label'];
              $options = ArrayHelper::getValue($item, 'options', []);
bedb55fe   Mihail   fixed Image class
111
              Html::addCssClass($options, ['panel' => 'panel', 'widget' => 'panel-default']);
70f4f18b   Administrator   first_commit
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
              $items[] = Html::tag('div', $this->renderItem($header, $item, ++$index), $options);
          }
  
          return implode("\n", $items);
      }
  
      /**
       * Renders a single collapsible item group
       * @param string $header a label of the item group [[items]]
       * @param array $item a single item from [[items]]
       * @param integer $index the item index as each item group content must have an id
       * @return string the rendering result
       * @throws InvalidConfigException
       */
      public function renderItem($header, $item, $index)
      {
          if (array_key_exists('content', $item)) {
              $id = $this->options['id'] . '-collapse' . $index;
              $options = ArrayHelper::getValue($item, 'contentOptions', []);
              $options['id'] = $id;
bedb55fe   Mihail   fixed Image class
132
              Html::addCssClass($options, ['widget' => 'panel-collapse', 'collapse' => 'collapse']);
70f4f18b   Administrator   first_commit
133
134
135
136
137
138
139
140
141
142
143
144
145
146
  
              $encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
              if ($encodeLabel) {
                  $header = Html::encode($header);
              }
  
              $headerToggle = Html::a($header, '#' . $id, [
                      'class' => 'collapse-toggle',
                      'data-toggle' => 'collapse',
                      'data-parent' => '#' . $this->options['id']
                  ]) . "\n";
  
              $header = Html::tag('h4', $headerToggle, ['class' => 'panel-title']);
  
bedb55fe   Mihail   fixed Image class
147
              if (is_string($item['content']) || is_object($item['content'])) {
70f4f18b   Administrator   first_commit
148
149
150
151
152
153
154
155
156
157
158
159
160
                  $content = Html::tag('div', $item['content'], ['class' => 'panel-body']) . "\n";
              } elseif (is_array($item['content'])) {
                  $content = Html::ul($item['content'], [
                      'class' => 'list-group',
                      'itemOptions' => [
                          'class' => 'list-group-item'
                      ],
                      'encode' => false,
                  ]) . "\n";
                  if (isset($item['footer'])) {
                      $content .= Html::tag('div', $item['footer'], ['class' => 'panel-footer']) . "\n";
                  }
              } else {
bedb55fe   Mihail   fixed Image class
161
                  throw new InvalidConfigException('The "content" option should be a string, array or object.');
70f4f18b   Administrator   first_commit
162
163
164
165
166
167
168
169
170
171
172
173
              }
          } else {
              throw new InvalidConfigException('The "content" option is required.');
          }
          $group = [];
  
          $group[] = Html::tag('div', $header, ['class' => 'panel-heading']);
          $group[] = Html::tag('div', $content, $options);
  
          return implode("\n", $group);
      }
  }