Класс yii\bootstrap\Progress
| Наследование | yii\bootstrap\Progress » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Использует трейты | yii\bootstrap\BootstrapWidgetTrait |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-bootstrap/blob/master/Progress.php |
Progress отображает компонент progress bar Bootstrap.
Например,
// 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']],
]
]);
См. также http://getbootstrap.com/components/#progress.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $barOptions | массив | Атрибуты HTML для полосы. | yii\bootstrap\Progress |
| $bars | массив | Набор полос, которые накладываются друг на друга, образуя единую полосу прогресса. | yii\bootstrap\Progress |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений. | yii\base\Component |
| $clientEvents | массив | Обработчики событий для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $clientOptions | массив | Опции для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $counter | целое число | Счетчик, используемый для генерации идентификатора $id для виджетов. | yii\base\Widget |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $label | строка | Текст метки. | yii\bootstrap\Progress |
| $options | массив | Атрибуты HTML для тега контейнера виджета. | yii\bootstrap\Widget |
| $percent | целое число | Процент завершенности. | yii\bootstrap\Progress |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который может быть использован для рендеринга представлений или файлов представления. | yii\bootstrap\BootstrapWidgetTrait |
| $viewPath | строка | Директория, содержащая файлы представления для этого виджета. | yii\base\Widget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после того, как объект был создан путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает работу виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли читать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает работу виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | yii\bootstrap\BootstrapWidgetTrait | |
| getViewPath() | Возвращает каталог, содержащий файлы представления для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\bootstrap\Progress |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| run() | Отображает виджет. | yii\bootstrap\Progress |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerClientEvents() | Регистрирует обработчики событий JavaScript, перечисленные в $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
| registerPlugin() | Регистрирует определённый плагин Bootstrap и связанные с ним события. | yii\bootstrap\BootstrapWidgetTrait |
| renderBar() | Создаёт полоску. | yii\bootstrap\Progress |
| renderProgress() | Отображает прогресс. | yii\bootstrap\Progress |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое непосредственно перед выполнением виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое вызывается при инициализации виджета с помощью init(). (доступно с версии 2.0.11) | yii\base\Widget |
Подробности свойств
$barOptions общедоступное свойство
Атрибуты HTML полоски.
См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
public array $barOptions = []
$bars общедоступное свойство
Набор полосок, которые расположены друг над другом, чтобы сформировать одну полосу прогресса. Каждая полоска — массив следующей структуры:
[
// 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 array $bars = null
$label общедоступное свойство
Текст метки кнопки.
public string $label = null
$percent общедоступное свойство
Величина прогресса в процентах.
public integer $percent = 0
Подробности методов
init() public method
Инициализирует виджет.
Если вы переопределяете этот метод, убедитесь, что вы сначала вызываете родительскую реализацию.
| public void init ( ) |
|---|
renderBar() protected method
Генерирует полосу прогресса
| protected string renderBar ( $percent, $label = '', $options = [] ) | ||
|---|---|---|
| $percent | integer |
Процент заполнения полосы |
| $label | ||
| $options | array |
HTML атрибуты полосы |
| return | string |
Результат рендеринга. |
renderProgress() protected method
Отображает прогресс.
| protected string renderProgress ( ) | ||
|---|---|---|
| return | string |
Результат рендеринга. |
| throws | yii\base\InvalidConfigException |
если параметр "percent" не задан в стековой полосе прогресса. |
run() public method
Отображает виджет.
| public void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-progress.html