Blame view

vendor/yiisoft/yii2-bootstrap/Carousel.php 5.76 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
63
64
65
66
67
68
69
70
71
72
73
74
  
  /**
   * Carousel renders a carousel bootstrap javascript component.
   *
   * For example:
   *
   * ```php
   * echo Carousel::widget([
   *     'items' => [
   *         // the item contains only the image
   *         '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
   *         // equivalent to the above
   *         ['content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-02.jpg"/>'],
   *         // the item contains both the image and the caption
   *         [
   *             'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-03.jpg"/>',
   *             'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
   *             'options' => [...],
   *         ],
   *     ]
   * ]);
   * ```
   *
   * @see http://getbootstrap.com/javascript/#carousel
   * @author Antonio Ramirez <amigo.cobos@gmail.com>
   * @since 2.0
   */
  class Carousel extends Widget
  {
      /**
       * @var array|boolean the labels for the previous and the next control buttons.
       * If false, it means the previous and the next control buttons should not be displayed.
       */
      public $controls = ['&lsaquo;', '&rsaquo;'];
      /**
       * @var boolean
       * If false carousel indicators (<ol> tag with anchors to items) should not be displayed.
       */
      public $showIndicators = true;
      /**
       * @var array list of slides in the carousel. Each array element represents a single
       * slide with the following structure:
       *
       * ```php
       * [
       *     // required, slide content (HTML), such as an image tag
       *     'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
       *     // optional, the caption (HTML) of the slide
       *     'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
       *     // optional the HTML attributes of the slide container
       *     'options' => [],
       * ]
       * ```
       */
      public $items = [];
  
  
      /**
       * Initializes the widget.
       */
      public function init()
      {
          parent::init();
bedb55fe   Mihail   fixed Image class
75
          Html::addCssClass($this->options, ['widget' => 'carousel']);
70f4f18b   Administrator   first_commit
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
139
140
141
142
143
144
145
146
147
148
149
150
151
      }
  
      /**
       * Renders the widget.
       */
      public function run()
      {
          $this->registerPlugin('carousel');
          return implode("\n", [
              Html::beginTag('div', $this->options),
              $this->renderIndicators(),
              $this->renderItems(),
              $this->renderControls(),
              Html::endTag('div')
          ]) . "\n";
      }
  
      /**
       * Renders carousel indicators.
       * @return string the rendering result
       */
      public function renderIndicators()
      {
          if ($this->showIndicators === false) {
              return '';
          }
          $indicators = [];
          for ($i = 0, $count = count($this->items); $i < $count; $i++) {
              $options = ['data-target' => '#' . $this->options['id'], 'data-slide-to' => $i];
              if ($i === 0) {
                  Html::addCssClass($options, 'active');
              }
              $indicators[] = Html::tag('li', '', $options);
          }
  
          return Html::tag('ol', implode("\n", $indicators), ['class' => 'carousel-indicators']);
      }
  
      /**
       * Renders carousel items as specified on [[items]].
       * @return string the rendering result
       */
      public function renderItems()
      {
          $items = [];
          for ($i = 0, $count = count($this->items); $i < $count; $i++) {
              $items[] = $this->renderItem($this->items[$i], $i);
          }
  
          return Html::tag('div', implode("\n", $items), ['class' => 'carousel-inner']);
      }
  
      /**
       * Renders a single carousel item
       * @param string|array $item a single item from [[items]]
       * @param integer $index the item index as the first item should be set to `active`
       * @return string the rendering result
       * @throws InvalidConfigException if the item is invalid
       */
      public function renderItem($item, $index)
      {
          if (is_string($item)) {
              $content = $item;
              $caption = null;
              $options = [];
          } elseif (isset($item['content'])) {
              $content = $item['content'];
              $caption = ArrayHelper::getValue($item, 'caption');
              if ($caption !== null) {
                  $caption = Html::tag('div', $caption, ['class' => 'carousel-caption']);
              }
              $options = ArrayHelper::getValue($item, 'options', []);
          } else {
              throw new InvalidConfigException('The "content" option is required.');
          }
  
bedb55fe   Mihail   fixed Image class
152
          Html::addCssClass($options, ['widget' => 'item']);
70f4f18b   Administrator   first_commit
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
          if ($index === 0) {
              Html::addCssClass($options, 'active');
          }
  
          return Html::tag('div', $content . "\n" . $caption, $options);
      }
  
      /**
       * Renders previous and next control buttons.
       * @throws InvalidConfigException if [[controls]] is invalid.
       */
      public function renderControls()
      {
          if (isset($this->controls[0], $this->controls[1])) {
              return Html::a($this->controls[0], '#' . $this->options['id'], [
                  'class' => 'left carousel-control',
                  'data-slide' => 'prev',
              ]) . "\n"
              . Html::a($this->controls[1], '#' . $this->options['id'], [
                  'class' => 'right carousel-control',
                  'data-slide' => 'next',
              ]);
          } elseif ($this->controls === false) {
              return '';
          } else {
              throw new InvalidConfigException('The "controls" property must be either false or an array of two elements.');
          }
      }
  }