Blame view

vendor/yiisoft/yii2-bootstrap/Progress.php 4.68 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
  
  /**
   * Progress renders a bootstrap progress bar component.
   *
   * For example,
   *
   * ```php
   * // default with label
   * echo Progress::widget([
   *     'percent' => 60,
   *     'label' => 'test',
   * ]);
   *
   * // styled
   * echo Progress::widget([
   *     'percent' => 65,
   *     'barOptions' => ['class' => 'progress-bar-danger']
   * ]);
   *
   * // striped
   * echo Progress::widget([
   *     'percent' => 70,
   *     'barOptions' => ['class' => 'progress-bar-warning'],
   *     'options' => ['class' => 'progress-striped']
   * ]);
   *
   * // striped animated
   * echo Progress::widget([
   *     'percent' => 70,
   *     'barOptions' => ['class' => 'progress-bar-success'],
   *     'options' => ['class' => 'active progress-striped']
   * ]);
   *
   * // stacked bars
   * echo Progress::widget([
   *     'bars' => [
   *         ['percent' => 30, 'options' => ['class' => 'progress-bar-danger']],
   *         ['percent' => 30, 'label' => 'test', 'options' => ['class' => 'progress-bar-success']],
   *         ['percent' => 35, 'options' => ['class' => 'progress-bar-warning']],
   *     ]
   * ]);
   * ```
   * @see http://getbootstrap.com/components/#progress
   * @author Antonio Ramirez <amigo.cobos@gmail.com>
   * @author Alexander Makarov <sam@rmcreative.ru>
   * @since 2.0
   */
  class Progress extends Widget
  {
      /**
       * @var string the button label.
       */
      public $label;
      /**
       * @var integer the amount of progress as a percentage.
       */
      public $percent = 0;
      /**
       * @var array the HTML attributes of the bar.
       * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
       */
      public $barOptions = [];
      /**
       * @var array a set of bars that are stacked together to form a single progress bar.
       * Each bar is an array of the following structure:
       *
       * ```php
       * [
       *     // required, the amount of progress as a percentage.
       *     'percent' => 30,
       *     // optional, the label to be displayed on the bar
       *     'label' => '30%',
       *     // optional, array, additional HTML attributes for the bar tag
       *     'options' => [],
       * ]
       * ```
       */
      public $bars;
  
  
      /**
       * Initializes the widget.
       * If you override this method, make sure you call the parent implementation first.
       */
      public function init()
      {
          parent::init();
bedb55fe   Mihail   fixed Image class
99
          Html::addCssClass($this->options, ['widget' => 'progress']);
70f4f18b   Administrator   first_commit
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
      }
  
      /**
       * Renders the widget.
       */
      public function run()
      {
          BootstrapAsset::register($this->getView());
          return implode("\n", [
              Html::beginTag('div', $this->options),
              $this->renderProgress(),
              Html::endTag('div')
          ]) . "\n";
      }
  
      /**
       * Renders the progress.
       * @return string the rendering result.
       * @throws InvalidConfigException if the "percent" option is not set in a stacked progress bar.
       */
      protected function renderProgress()
      {
          if (empty($this->bars)) {
              return $this->renderBar($this->percent, $this->label, $this->barOptions);
          }
          $bars = [];
          foreach ($this->bars as $bar) {
              $label = ArrayHelper::getValue($bar, 'label', '');
              if (!isset($bar['percent'])) {
                  throw new InvalidConfigException("The 'percent' option is required.");
              }
              $options = ArrayHelper::getValue($bar, 'options', []);
              $bars[] = $this->renderBar($bar['percent'], $label, $options);
          }
  
          return implode("\n", $bars);
      }
  
      /**
       * Generates a bar
       * @param integer $percent the percentage of the bar
       * @param string $label, optional, the label to display at the bar
       * @param array $options the HTML attributes of the bar
       * @return string the rendering result.
       */
      protected function renderBar($percent, $label = '', $options = [])
      {
          $defaultOptions = [
              'role' => 'progressbar',
              'aria-valuenow' => $percent,
              'aria-valuemin' => 0,
              'aria-valuemax' => 100,
              'style' => "width:{$percent}%",
          ];
          $options = array_merge($defaultOptions, $options);
bedb55fe   Mihail   fixed Image class
155
          Html::addCssClass($options, ['widget' => 'progress-bar']);
70f4f18b   Administrator   first_commit
156
157
158
159
160
161
162
163
164
165
166
  
          $out = Html::beginTag('div', $options);
          $out .= $label;
          $out .= Html::tag('span', \Yii::t('yii', '{percent}% Complete', ['percent' => $percent]), [
              'class' => 'sr-only'
          ]);
          $out .= Html::endTag('div');
  
          return $out;
      }
  }