Класс yii\data\Sort

Sort представляет информацию, относящуюся к сортировке.

Когда данные нужно отсортировать по одному или нескольким атрибутам, мы можем использовать Sort для представления информации о сортировке и генерации соответствующих гиперссылок, которые могут привести к действиям сортировки.

Типичный пример использования:

public function actionIndex()
{
    $sort = new Sort([
        'attributes' => [
            'age',
            'name' => [
                'asc' => ['first_name' => SORT_ASC, 'last_name' => SORT_ASC],
                'desc' => ['first_name' => SORT_DESC, 'last_name' => SORT_DESC],
                'default' => SORT_DESC,
                'label' => 'Name',
            ],
        ],
    ]);

    $models = Article::find()
        ->where(['status' => 1])
        ->orderBy($sort->orders)
        ->all();

    return $this->render('index', [
         'models' => $models,
         'sort' => $sort,
    ]);
}

Представление:

// display links leading to sort actions
echo $sort->link('name') . ' | ' . $sort->link('age');

foreach ($models as $model) {
    // display $model here
}

В примере выше мы объявляем два $attributes, поддерживающих сортировку: name и age. Мы передаем информацию о сортировке в запрос Article, чтобы результаты запроса были отсортированы в порядке, указанном объектом Sort. В представлении мы отображаем две гиперссылки, которые могут привести к страницам с данными, отсортированными по соответствующим атрибутам.

Для получения более подробной информации и сведений об использовании Sort, см. статью руководства по сортировке.

Свойства Public

Методы Public

Методы Protected

Подробное описание свойств

$attributeOrders свойство public

Направления сортировки, индексированные по именам атрибутов. Направление сортировки может быть SORT_ASC для возрастания или SORT_DESC для убывания.

public array getAttributeOrders ( $recalculate = false )
public void setAttributeOrders ( $attributeOrders, $validate = true )

$attributes свойство public

Список атрибутов, которые могут быть отсортированы. Его синтаксис можно описать на следующем примере:

[
    'age',
    'name' => [
        'asc' => ['first_name' => SORT_ASC, 'last_name' => SORT_ASC],
        'desc' => ['first_name' => SORT_DESC, 'last_name' => SORT_DESC],
        'default' => SORT_DESC,
        'label' => 'Name',
    ],
]

В примере выше объявлены два атрибута: age и name. Атрибут age - это простой атрибут, эквивалентный следующему:

'age' => [
    'asc' => ['age' => SORT_ASC],
    'desc' => ['age' => SORT_DESC],
    'default' => SORT_ASC,
    'label' => Inflector::camel2words('age'),
]

Начиная с версии 2.0.12, конкретное направление сортировки также может быть указано в виде прямого выражения сортировки, как показано ниже:

'name' => [
    'asc' => '[[last_name]] ASC NULLS FIRST', // PostgreSQL specific feature
    'desc' => '[[last_name]] DESC NULLS LAST',
]

Атрибут name - это составной атрибут:

• Ключ name представляет имя атрибута, которое будет отображаться в URL-адресах, ведущих к действиям сортировки.
• Элементы asc и desc указывают, как сортировать по атрибуту в порядке возрастания и убывания соответственно. Их значения представляют фактические столбцы и направления, по которым должны быть отсортированы данные.
• Элемент default указывает направление сортировки атрибута, если он не отсортирован (по умолчанию - возрастание).
• Элемент label указывает метку, которая должна использоваться при вызове link() для создания ссылки сортировки. Если не указано, будет вызван yii\helpers\Inflector::camel2words() для получения метки. Обратите внимание, что она не будет закодирована в HTML.

Обратите внимание, что если объект Sort уже создан, вы можете использовать только полный формат для настройки каждого атрибута. Каждый атрибут должен включать эти элементы: asc и desc.

public array $attributes = []

$defaultOrder открытое свойство

Порядок, который следует использовать, когда текущий запрос не указывает никакого порядка. Ключи массива — имена атрибутов, а значения массива — соответствующие направления сортировки. Например,

[
    'name' => SORT_ASC,
    'created_at' => SORT_DESC,
]

См. также $attributeOrders.

public array $defaultOrder = null

$enableMultiSort открытое свойство

Можно ли применить сортировку к нескольким атрибутам одновременно. По умолчанию false, что означает, что каждый раз данные можно сортировать только по одному атрибуту.

public boolean $enableMultiSort = false

$orders открытое только для чтения свойство

Столбцы (ключи) и соответствующие направления сортировки (значения). Это можно передать в yii\db\Query::orderBy() для построения запроса к базе данных.

public array getOrders ( $recalculate = false )

$params открытое свойство

Параметры (имя => значение), которые следует использовать для получения текущих направлений сортировки и создания новых ссылок на страницы сортировки. Если не задано, будет использоваться $_GET вместо.

Для добавления хэша ко всем ссылкам используйте array_merge($_GET, ['#' => 'my-hash']).

Элемент массива с индексом $sortParam рассматривается как текущие направления сортировки. Если элемента не существует, будет использоваться по умолчанию порядок.

См. также:

• $sortParam
• $defaultOrder

public array $params = null

$route открытое свойство

Маршрут действия контроллера для отображения отсортированного содержимого. Если не задано, используется текущий запрашиваемый маршрут.

public string $route = null

$separator открытое свойство

Символ, используемый для разделения различных атрибутов, которые нужно отсортировать.

public string $separator = ','

$sortParam открытое свойство

Имя параметра, указывающего, какие атрибуты и в каком направлении сортировать. По умолчанию sort.

См. также $params.

public string $sortParam = 'sort'

$urlManager открытое свойство

Менеджер URL, используемый для создания ссылок на страницы сортировки. Если не задано, будет использован компонент urlManager приложения.

public yii\web\UrlManager $urlManager = null

Подробное описание методов

[
    'category',
    '-created_at'
]