Initial commit,修正
This commit is contained in:
+191
@@ -0,0 +1,191 @@
|
||||
<?php
|
||||
/**
|
||||
* @link https://www.yiiframework.com/
|
||||
* @copyright Copyright (c) 2008 Yii Software LLC
|
||||
* @license https://www.yiiframework.com/license/
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace yii\bootstrap5;
|
||||
|
||||
use Exception;
|
||||
use yii\base\InvalidConfigException;
|
||||
use yii\helpers\ArrayHelper;
|
||||
|
||||
/**
|
||||
* Progress renders a bootstrap progress bar component.
|
||||
*
|
||||
* For example,
|
||||
*
|
||||
* ```php
|
||||
* // default with label
|
||||
* echo Progress::widget([
|
||||
* 'percent' => 60,
|
||||
* 'label' => 'test'
|
||||
* ]);
|
||||
* // or
|
||||
* echo Progress::widget([
|
||||
* 'bars' => [
|
||||
* ['percent' => 60, 'label' => 'test']
|
||||
* ]
|
||||
* ]);
|
||||
*
|
||||
* // styled
|
||||
* echo Progress::widget([
|
||||
* 'percent' => 65,
|
||||
* 'barOptions' => ['class' => 'bg-danger']
|
||||
* ]);
|
||||
* // or
|
||||
* echo Progress::widget([
|
||||
* 'bars' => [
|
||||
* ['percent' => 65, 'options' => ['class' => 'bg-danger']]
|
||||
* ]
|
||||
* ]);
|
||||
*
|
||||
* // striped
|
||||
* echo Progress::widget([
|
||||
* 'percent' => 70,
|
||||
* 'barOptions' => ['class' => ['bg-warning', 'progress-bar-striped']]
|
||||
* ]);
|
||||
* // or
|
||||
* echo Progress::widget([
|
||||
* 'bars' => [
|
||||
* ['percent' => 70, 'options' => ['class' => ['bg-warning', 'progress-bar-striped']]]
|
||||
* ]
|
||||
* ]);
|
||||
*
|
||||
* // striped animated
|
||||
* echo Progress::widget([
|
||||
* 'percent' => 70,
|
||||
* 'barOptions' => ['class' => ['bg-success', 'progress-bar-animated', 'progress-bar-striped']]
|
||||
* ]);
|
||||
* // or
|
||||
* echo Progress::widget([
|
||||
* 'bars' => [
|
||||
* ['percent' => 70, 'options' => ['class' => ['bg-success', 'progress-bar-animated', 'progress-bar-striped']]]
|
||||
* ]
|
||||
* ]);
|
||||
*
|
||||
* // stacked bars
|
||||
* echo Progress::widget([
|
||||
* 'bars' => [
|
||||
* ['percent' => 30, 'options' => ['class' => 'bg-danger']],
|
||||
* ['percent' => 30, 'label' => 'test', 'options' => ['class' => 'bg-success']],
|
||||
* ['percent' => 35, 'options' => ['class' => 'bg-warning']],
|
||||
* ]
|
||||
* ]);
|
||||
* ```
|
||||
* @see https://getbootstrap.com/docs/5.1/components/progress/
|
||||
* @author Antonio Ramirez <amigo.cobos@gmail.com>
|
||||
* @author Alexander Makarov <sam@rmcreative.ru>
|
||||
* @author Simon Karlen <simi.albi@outlook.com>
|
||||
*/
|
||||
class Progress extends Widget
|
||||
{
|
||||
/**
|
||||
* @var string the button label. This property will only be considered if [[bars]] is empty
|
||||
*/
|
||||
public $label;
|
||||
/**
|
||||
* @var int the amount of progress as a percentage. This property will only be considered if [[bars]] is empty
|
||||
*/
|
||||
public $percent = 0;
|
||||
/**
|
||||
* @var array the HTML attributes of the bar. This property will only be considered if [[bars]] is empty
|
||||
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
|
||||
* @since 2.0.6
|
||||
*/
|
||||
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;
|
||||
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
parent::init();
|
||||
|
||||
Html::addCssClass($this->options, ['widget' => 'progress']);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* @throws InvalidConfigException
|
||||
*/
|
||||
public function run(): string
|
||||
{
|
||||
BootstrapAsset::register($this->getView());
|
||||
|
||||
return $this->renderProgress();
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders the progress.
|
||||
* @return string the rendering result.
|
||||
* @throws InvalidConfigException if the "percent" option is not set in a stacked progress bar.
|
||||
* @throws Exception
|
||||
*/
|
||||
protected function renderProgress(): string
|
||||
{
|
||||
$out = Html::beginTag('div', $this->options) . "\n";
|
||||
if (empty($this->bars)) {
|
||||
$this->bars = [
|
||||
['label' => $this->label, 'percent' => $this->percent, 'options' => $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);
|
||||
}
|
||||
$out .= implode("\n", $bars) . "\n";
|
||||
$out .= Html::endTag('div');
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a progress 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(int $percent, string $label = '', array $options = []): string
|
||||
{
|
||||
|
||||
$options = array_merge($options, [
|
||||
'role' => 'progressbar',
|
||||
'aria' => [
|
||||
'valuenow' => $percent,
|
||||
'valuemin' => 0,
|
||||
'valuemax' => 100,
|
||||
]
|
||||
]);
|
||||
Html::addCssClass($options, ['widget' => 'progress-bar']);
|
||||
Html::addCssStyle($options, ['width' => $percent . '%'], true);
|
||||
|
||||
return Html::tag('div', $label, $options);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user