Класс yii\widgets\LinkSorter
| Наследование | yii\widgets\LinkSorter » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/widgets/LinkSorter.php |
LinkSorter отображает список ссылок сортировки для данного определения сортировки.
LinkSorter сгенерирует гиперссылку для каждого атрибута, объявленного в $sort.
Для получения более подробной информации и использования LinkSorter, см. статью руководства по сортировке.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $attributes | массив | Список атрибутов, которые поддерживают сортировку. | yii\widgets\LinkSorter |
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $counter | целое число | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $linkOptions | массив | Атрибуты HTML для ссылки в контейнере сортировщика, которые передаются в yii\data\Sort::link(). | yii\widgets\LinkSorter |
| $options | массив | Атрибуты HTML для тега контейнера сортировщика. | yii\widgets\LinkSorter |
| $sort | yii\data\Sort | Определение сортировки | yii\widgets\LinkSorter |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представления. | yii\base\Widget |
| $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\base\Widget |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для данного виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует сортировщик. | yii\widgets\LinkSorter |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\widgets\LinkSorter |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создает экземпляр виджета и выполняет его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| renderSortLinks() | Рендерит ссылки сортировки. | yii\widgets\LinkSorter |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробности о свойствах
$attributes общедоступное свойство
Список атрибутов, поддерживающих сортировку. Если не задано, он будет определен с помощью yii\data\Sort::$attributes.
public array $attributes = null
$linkOptions общедоступное свойство (доступно начиная с версии 2.0.6)
Атрибуты HTML для ссылки в контейнере сортировщика, которые передаются в yii\data\Sort::link().
См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как рендерятся атрибуты.
public array $linkOptions = []
$options общедоступное свойство
Атрибуты HTML для тега контейнера сортировщика.
См. также:
- yii\helpers\Html::ul() для специальных атрибутов.
- yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как рендерятся атрибуты.
public array $options = ['class' => 'sorter']
$sort общедоступное свойство
Определение сортировки
public yii\data\Sort $sort = null
Подробности о методах
init() public method
Инициализирует сортировщик.
| public void init ( ) |
|---|
renderSortLinks() protected method
Отображает ссылки сортировки.
| protected string renderSortLinks ( ) | ||
|---|---|---|
| return | string |
Результат отображения |
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-widgets-linksorter.html
