Specify Sort fields (#85)

* Specify Sort fields See yiisoft/data#66 Co-authored-by: Aleksei Gagarin <roxblnfk@ya.ru>
yiisoft · Dec 10, 2020 · 2dffc42 · 2dffc42
1 parent babc9b9
commit 2dffc42
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,6 @@ Read more in the [official Cycle documentation](https://github.com/cycle/docs)
 [![static analysis](https://github.com/yiisoft/yii-cycle/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-cycle/actions?query=workflow%3A%22static+analysis%22)
 [![type-coverage](https://shepherd.dev/github/yiisoft/yii-cycle/coverage.svg)](https://shepherd.dev/github/yiisoft/yii-cycle)
 
-
 ### Documentation
 
 - [English](docs/en/README.md)

diff --git a/docs/en/installation.md b/docs/en/installation.md
@@ -1,8 +1,8 @@
 # Installation
 
-The preferred way to install this package is through [composer](http://getcomposer.org/download/):
+The preferred way to install this package is through [Composer](https://getcomposer.org/download/):
 
-```
+```bash
 composer require yiisoft/yii-cycle
 ```
 

diff --git a/docs/en/select-data-reader.md b/docs/en/select-data-reader.md
@@ -86,8 +86,8 @@ Now we'll query for 20 latest published articles, then for 20 first articles.
 $lastPublicReader = $articles->withLimit(20);
 
 // Ordering is specified with Sort object:
-$sort = (new \Yiisoft\Data\Reader\Sort([]))->withOrder(['published_at' => 'desc']);
-// Note that neither Sort not SelectDataReader would not check field correctness.
+$sort = (new \Yiisoft\Data\Reader\Sort(['published_at']))->withOrder(['published_at' => 'desc']);
+// Note that SelectDataReader would not check Sort field correctness.
 // Specifying non-existing fields would result in an error in Cycle code
 
 // Don't forget about immutability when applying sorting rules
@@ -136,7 +136,7 @@ class ArticleRepository extends \Cycle\ORM\Select\Repository
      */
     public function findPublic(): DataReaderInterface
     {
-        $sort = (new Sort([]))->withOrder(['published_at' => 'desc']);
+        $sort = (new Sort(['published_at']))->withOrder(['published_at' => 'desc']);
         return (new SelectDataReader($this->select()->where(['public' => true])))->withSort($sort);
     }
 }
@@ -149,7 +149,7 @@ function index(ArticleRepository $repository)
         // Getting SelectDataReader
         ->findPublic()
         // Applying new sorting
-        ->withSort((new Sort([]))->withOrder(['published_at' => 'asc']));
+        ->withSort((new Sort(['published_at']))->withOrder(['published_at' => 'asc']));
 }
 ```
 You may refine query conditions with filters. This filtering conditions are adding to original select query conditions, but NOT replace them.

diff --git a/docs/ru/installation.md b/docs/ru/installation.md
@@ -1,8 +1,8 @@
 # Установка
 
-Предпочтительнее установить этот пакет через [composer](http://getcomposer.org/download/):
+Предпочтительнее установить этот пакет через [Composer](https://getcomposer.org/download/):
 
-```
+```bash
 composer require yiisoft/yii-cycle
 ```
 

diff --git a/docs/ru/select-data-reader.md b/docs/ru/select-data-reader.md
@@ -89,9 +89,9 @@ foreach ($paginator->read() as $article) {
 $lastPublicReader = $articles->withLimit(20);
 
 // Правила сортировки описываются в объекте класса Sort:
-$sort = (new \Yiisoft\Data\Reader\Sort([]))->withOrder(['published_at' => 'desc']);
-// Учтите, что ни объект Sort, ни SelectDataReader НЕ БУДУТ проверять правильность
-// указанных полей! Указание несуществующих полей приведёт к ошибке в коде Cycle
+$sort = (new \Yiisoft\Data\Reader\Sort(['published_at']))->withOrder(['published_at' => 'desc']);
+// Учтите, что SelectDataReader НЕ БУДЕТ проверять правильность указанных в Sort полей!
+// Указание несуществующих в таблице полей приведёт к ошибке в коде Cycle
 
 // Применяем правила сортировки и не забываем об иммутабельности
 $lastPublicReader = $lastPublicReader->withSort($sort);
@@ -136,7 +136,7 @@ class ArticleRepository extends \Cycle\ORM\Select\Repository
 {
     public function findPublic(): DataReaderInterface
     {
-        $sort = (new Sort([]))->withOrder(['published_at' => 'desc']);
+        $sort = (new Sort(['published_at']))->withOrder(['published_at' => 'desc']);
         // Параметры сортировки присваиваются объекту DataReader, а не \Cycle\ORM\Select
         return (new SelectDataReader($this->select()->where(['public' => true])))->withSort($sort);
     }
@@ -150,7 +150,7 @@ function index(ArticleRepository $repository)
         // Получаем объект SelectDataReader
         ->findPublic()
         // Применяем новое правило сортировки
-        ->withSort((new Sort([]))->withOrder(['published_at' => 'asc']));
+        ->withSort((new Sort(['published_at']))->withOrder(['published_at' => 'asc']));
 }
 ```