Progress.php 3.83 KB
Newer Older
Antonio Ramirez committed
1 2 3 4 5 6 7 8 9 10
<?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;
Qiang Xue committed
11
use yii\helpers\ArrayHelper;
Antonio Ramirez committed
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
use yii\helpers\Html;


/**
 * Progress renders a bootstrap progress bar component.
 *
 * For example,
 *
 * ```php
 * // default with label
 * echo Progress::widget(array(
 *     'percent' => 60,
 *     'label' => 'test',
 * ));
 *
 * // styled
 * echo Progress::widget(array(
 *     'percent' => 65,
 *     'barOptions' => array('class' => 'bar-danger')
 * ));
 *
 * // striped
 * echo Progress::widget(array(
 *     'percent' => 70,
 *     'barOptions' => array('class' => 'bar-warning'),
 *     'options' => array('class' => 'progress-striped')
 * ));
 *
 * // striped animated
 * echo Progress::widget(array(
 *     'percent' => 70,
 *     'barOptions' => array('class' => 'bar-success'),
 *     'options' => array('class' => 'active progress-striped')
 * ));
 *
Qiang Xue committed
47
 * // stacked bars
Antonio Ramirez committed
48
 * echo Progress::widget(array(
Qiang Xue committed
49
 *     'bars' => array(
Antonio Ramirez committed
50
 *         array('percent' => 30, 'options' => array('class' => 'bar-danger')),
Qiang Xue committed
51
 *         array('percent' => 30, 'label'=>'test', 'options' => array('class' => 'bar-success')),
Antonio Ramirez committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 *         array('percent' => 35, 'options' => array('class' => 'bar-warning'))
 *     )
 * ));
 * ```
 * @see http://twitter.github.io/bootstrap/components.html#progress
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @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
	 */
	public $barOptions = array();
	/**
Qiang Xue committed
75 76
	 * @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:
Antonio Ramirez committed
77 78
	 *
	 * ```php
Qiang Xue committed
79 80 81 82 83 84 85 86
	 * array(
	 *     // 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' => array(),
	 * )
Antonio Ramirez committed
87
	 */
Qiang Xue committed
88
	public $bars;
Antonio Ramirez committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108


	/**
	 * Initializes the widget.
	 * If you override this method, make sure you call the parent implementation first.
	 */
	public function init()
	{
		parent::init();
		$this->addCssClass($this->options, 'progress');
	}

	/**
	 * Renders the widget.
	 */
	public function run()
	{
		echo Html::beginTag('div', $this->options) . "\n";
		echo $this->renderProgress() . "\n";
		echo Html::endTag('div') . "\n";
Qiang Xue committed
109
		$this->getView()->registerAssetBundle(static::$responsive ? 'yii/bootstrap/responsive' : 'yii/bootstrap');
Antonio Ramirez committed
110 111 112
	}

	/**
Qiang Xue committed
113
	 * Renders the progress.
Antonio Ramirez committed
114
	 * @return string the rendering result.
Qiang Xue committed
115
	 * @throws InvalidConfigException if the "percent" option is not set in a stacked progress bar.
Antonio Ramirez committed
116 117 118
	 */
	protected function renderProgress()
	{
Qiang Xue committed
119 120
		if (empty($this->bars)) {
			return $this->renderBar($this->percent, $this->label, $this->barOptions);
Antonio Ramirez committed
121 122
		}
		$bars = array();
Qiang Xue committed
123 124 125
		foreach ($this->bars as $bar) {
			$label = ArrayHelper::getValue($bar, 'label', '');
			if (!isset($bar['percent'])) {
Antonio Ramirez committed
126 127
				throw new InvalidConfigException("The 'percent' option is required.");
			}
Qiang Xue committed
128 129
			$options = ArrayHelper::getValue($bar, 'options', array());
			$bars[] = $this->renderBar($bar['percent'], $label, $options);
Antonio Ramirez committed
130 131 132 133
		}
		return implode("\n", $bars);
	}

Qiang Xue committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147
	/**
	 * Generates a bar
	 * @param int $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 = array())
	{
		$this->addCssClass($options, 'bar');
		$options['style'] = "width:{$percent}%";
		return Html::tag('div', $label, $options);
	}
}