From 9d868cf7a286b1d2e734b8a3c1a7fc0762ec023b Mon Sep 17 00:00:00 2001 From: bogdan demchenko Date: Sun, 7 Oct 2018 16:26:29 +0300 Subject: [PATCH] Fix a few links on docs/guide-ru/structure-extensions.md (#16773) [skip ci] --- docs/guide-ru/glossary.md | 67 +++++++++++++++++++++++++++ docs/guide-ru/helper-html.md | 10 ++-- docs/guide-ru/rest-quick-start.md | 9 ++-- docs/guide-ru/start-gii.md | 6 +-- docs/guide-ru/structure-extensions.md | 14 +++--- docs/guide-ru/structure-modules.md | 6 +-- 6 files changed, 91 insertions(+), 21 deletions(-) create mode 100644 docs/guide-ru/glossary.md diff --git a/docs/guide-ru/glossary.md b/docs/guide-ru/glossary.md new file mode 100644 index 0000000000..7f7085ce4e --- /dev/null +++ b/docs/guide-ru/glossary.md @@ -0,0 +1,67 @@ +# A + +## alias + +Alias это строка которую Yii использует чтобы указывать на класс или директорию, например '@app/vendor'. + +## application + +Приложение является центральным объектом на протяжении HTTP запроса. Оно сожержит несколько компонентов и с ними получает информацию из запроса и отправляет ее для дальнейшей обработки. + +Объект приложения создается в виде синглтона входным скриптом. Объект приложения доступен из любого места через `\Yii::$app`. + +## assets + +Asset относится к файлу ресурса. Обычно он содержит JavaScript или CSS код, но может быть чем-то другим, к чему есть доступ по HTTP. + +## attribute + +Атрибут - это свойство модели (переменная класса или магическое свойство, определенное через `__get()`/`__set()`) в котором хранится **бизнес логика**. + +# B + +## bundle + +Bundle, известный как пакет в Yii 1.1, относится к ряду ресурсов и конфигурационному файлу, который описывает зависимости и списки ресурсов. + +# C + +## configuration + +Конфигурация может относиться как к процессу установки свойств объекта либо к конфигурации файла, хранящего настройки объекта или класса объектов. + +# E + +## extension + +Расширения это набор классов, комплект ресурсов и конфигураций, которые добавляют приложению функциональность. + +# I + +## installation + +Установка это процесс подготовки чего-либо к работе либо путем чтения readme файла или выполнением подготовленного сценария. В случае Yii он устанавливает разрешения и необходимые зависимости. + +# M + +## module + +Модуль это подпрограмма которая содержит элементы MVC, такие как модели, представления, контроллеры и т.д. и может быть использована без главного приложения. Обычно пробрасывая запросы в модуль вместо обработки контроллером. + +# N + +## namespace + +Пространство имен ссылка на [PHP language feature](http://php.net/manual/en/language.namespaces.php) который активно используется в Yii 2. + +# P + +## package + +[Смотри bundle](#bundle). + +# V + +## vendor + +Vendor - это организация или отдельный разработчик, распространяющие код в форме расширений, модулей или библиотек. \ No newline at end of file diff --git a/docs/guide-ru/helper-html.md b/docs/guide-ru/helper-html.md index e80afc993e..b30a53cfa3 100644 --- a/docs/guide-ru/helper-html.md +++ b/docs/guide-ru/helper-html.md @@ -244,11 +244,11 @@ $decodedUserName = Html::decode($userName); Сигнатура методов для формирования радио-переключателей и чекбоксов немного отличается: ```php - 'Я согласен']); - 'agreement']) + 'Я согласен']) ?> + 'agreement']) ?> - 'Я согласен']); - 'agreement']) + 'Я согласен']) ?> + 'agreement']) ?> ``` Выпадающие и обычные списки могут быть сформированы следующим образом: @@ -354,7 +354,7 @@ echo Html::getAttributeName('dates[0]'); - true]); + true]) ?> Результатом будет: diff --git a/docs/guide-ru/rest-quick-start.md b/docs/guide-ru/rest-quick-start.md index 64e82532fa..326a952cff 100644 --- a/docs/guide-ru/rest-quick-start.md +++ b/docs/guide-ru/rest-quick-start.md @@ -8,6 +8,7 @@ Yii включает полноценный набор средств для у * Настройка формата ответа (JSON и XML реализованы по умолчанию); * Получение сериализованных объектов с нужной вам выборкой полей; * Надлежащее форматирование данных и ошибок при их валидации; +* Коллекция пагинаций, фильтров и сортировок; * Поддержка [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS); * Эффективная маршрутизация с надлежащей проверкой HTTP методов; * Встроенная поддержка методов `OPTIONS` и `HEAD`; @@ -91,8 +92,6 @@ URL и логичные глаголы HTTP. * `OPTIONS /users`: получение поддерживаемых методов, по которым можно обратится к `/users`; * `OPTIONS /users/123`: получение поддерживаемых методов, по которым можно обратится к `/users/123`. -> Info: Yii автоматически использует множественное число от имени контроллера в URL. - Пробуем получить ответы по API используя `curl`: ``` @@ -172,9 +171,13 @@ Content-Type: application/xml > Info: Вы наверное заметили, что при обращении к `http://localhost/users` мы получаем информацию с полями, -> которые нежелательно показывать, такими как `password_hash` и `auth_key`. Вы можете и должны отфильтровать их как +> которые нежелательно показывать, такими как `password_hash` и `auth_key`. Вы можете и должны удалить эти поля как > описано в разделе «[Ресурсы](rest-resources.md)». +Дополнительно, вы можете отсортировать коллекции как `http://localhost/users?sort=email` или +`http://localhost/users?sort=-email`. Фильтрация коллекций как `http://localhost/users?filter[id]=10` или +`http://localhost/users?filter[email][like]=gmail.com` возможна при использовании +фильтров данных. Подробнее в секции [Resources](rest-resources.md#filtering-collections). ## Резюме diff --git a/docs/guide-ru/start-gii.md b/docs/guide-ru/start-gii.md index f68ef7a8da..bf0e4762e6 100644 --- a/docs/guide-ru/start-gii.md +++ b/docs/guide-ru/start-gii.md @@ -1,7 +1,7 @@ Генерация кода при помощи Gii ======================== -В этом разделе мы опишем, как использовать [Gii](https://github.com/yiisoft/yii2-gii/blob/master/docs/guide-ru/README.md) для автоматической генерации кода, +В этом разделе мы опишем, как использовать [Gii](https://www.yiiframework.com/extension/yiisoft/yii2-gii/doc/guide) для автоматической генерации кода, реализующего некоторые общие функции вебсайта. Для достижения этой цели всё, что вам нужно, это просто ввести необходимую информацию в соответствии с инструкциями, отображаемыми на веб-страницах Gii. В этом руководстве вы узнаете: @@ -15,7 +15,7 @@ Запускаем Gii ------------ -[Gii](https://github.com/yiisoft/yii2-gii/blob/master/docs/guide-ru/README.md) представлен в Yii как [модуль](structure-modules.md). Вы можете активировать Gii, +[Gii](https://www.yiiframework.com/extension/yiisoft/yii2-gii/doc/guide) представлен в Yii как [модуль](structure-modules.md). Вы можете активировать Gii, настроив его в свойстве [[yii\base\Application::modules|modules]]. В зависимости от того, каким образом вы создали приложение, вы можете удостовериться в наличии следующего кода в конфигурационном файле `config/web.php`, ```php @@ -119,7 +119,7 @@ http://hostname/index.php?r=country%2Findex * Модели: `models/Country.php` и `models/CountrySearch.php` * Вид: `views/country/*.php` -> Info: Gii разработан как тонконастраиваемый и расширяемый инструмент генерации кода. Используя его с умом, вы можете значительно ускорить скорость разработки приложений. Для более подробной информации, пожалуйста, обратитесь к разделу [Gii](https://github.com/yiisoft/yii2-gii/blob/master/docs/guide-ru/README.md). +> Info: Gii разработан как тонконастраиваемый и расширяемый инструмент генерации кода. Используя его с умом, вы можете значительно ускорить скорость разработки приложений. Для более подробной информации, пожалуйста, обратитесь к разделу [Gii](https://www.yiiframework.com/extension/yiisoft/yii2-gii/doc/guide). Заключение diff --git a/docs/guide-ru/structure-extensions.md b/docs/guide-ru/structure-extensions.md index 97d93d9a29..038cf76176 100644 --- a/docs/guide-ru/structure-extensions.md +++ b/docs/guide-ru/structure-extensions.md @@ -374,25 +374,25 @@ class MyBootstrapClass implements BootstrapInterface ## Базовые расширения -Yii предоставляет следующие базовые расширения, которые разрабатывает и поддерживает команда разработчиков Yii. Они все +Yii предоставляет следующие базовые расширения, (или ["Official Extensions"](https://www.yiiframework.com/extensions/official)) которые разрабатывает и поддерживает команда разработчиков Yii. Они все зарегистрированы на [Packagist](https://packagist.org/) и могут быть легко установлены, как описано в подразделе [Использование расширений](#using-extensions). -- [yiisoft/yii2-apidoc](https://github.com/yiisoft/yii2-apidoc): +- [yiisoft/yii2-apidoc](https://www.yiiframework.com/extension/yiisoft/yii2-apidoc): предоставляет расширяемый и высокопроизводительный генератор документации API. Оно также используется для генерации документации API фреймворка. -- [yiisoft/yii2-authclient](https://github.com/yiisoft/yii2-authclient): +- [yiisoft/yii2-authclient](https://www.yiiframework.com/extension/yiisoft/yii2-authclient): предоставляет набор наиболее часто используемых клиентов авторизации, таких, как Facebook OAuth2 клиент и GitHub OAuth2 клиент. -- [yiisoft/yii2-bootstrap](https://github.com/yiisoft/yii2-bootstrap): +- [yiisoft/yii2-bootstrap](https://www.yiiframework.com/extension/yiisoft/yii2-bootstrap): предоставляет набор виджетов, которые являются компонентами и плагинами [Bootstrap](http://getbootstrap.com/). -- [yiisoft/yii2-codeception](https://github.com/yiisoft/yii2-codeception): +- [yiisoft/yii2-codeception](https://github.com/yiisoft/yii2-codeception) (deprecated): предоставляет поддержку тестирования, основанного на [Codeception](http://codeception.com/). -- [yiisoft/yii2-debug](https://github.com/yiisoft/yii2-debug): +- [yiisoft/yii2-debug](https://www.yiiframework.com/extension/yiisoft/yii2-debug): предоставляет поддержку отладки в приложениях Yii. Когда это расширение используется, отладочная панель появится в нижней части каждой страницы. Это расширение также предоставляет набор отдельных страниц для отображения более подробной отладочной информации. -- [yiisoft/yii2-elasticsearch](https://github.com/yiisoft/yii2-elasticsearch): +- [yiisoft/yii2-elasticsearch](https://www.yiiframework.com/extension/yiisoft/yii2-elasticsearch): предоставляет поддержку использования [Elasticsearch](http://www.elasticsearch.org/). Оно включает в себя поддержку основных поисковых запросов, а также реализует шаблон проектирования [Active Record](db-active-record.md), который позволяет хранить записи Active Record в Elasticsearch. diff --git a/docs/guide-ru/structure-modules.md b/docs/guide-ru/structure-modules.md index ebd2a95f25..6833bb56cc 100644 --- a/docs/guide-ru/structure-modules.md +++ b/docs/guide-ru/structure-modules.md @@ -171,13 +171,13 @@ yii // из идентификатора модуля, то контроллер и действие определяются исходя из свойства [[yii\base\Module::defaultRoute]], которое по умолчанию равно `default`. Таким образом, маршрут `forum` соответствует контроллеру `default` модуля `forum`. -Добавление маршрутов модуля в URL manager необходимо производить до начала работы [[yii\web\UrlManager::parseRequest()]], что не +Правила в URL manager для модулей должны быть добавленны перед началом работы [[yii\web\UrlManager::parseRequest()]], что не позволяет размещать код добавления правил модуля в `init()`, так как инициализация происходит уже после обработки маршрутов. Таким образом, добавление маршрутов необходимо осуществить в [предзагрузке модуля](structure-extensions.md#bootstrapping-classes). Хорошей практикой, также, будет объединение всех правил модуля при помощи [[\yii\web\GroupUrlRule]]. -Если же вы используете модуль для [версионирования API](rest-versioning.md), добавление маршрутов необходимо -производить непосредственно в конфигурации `urlManager` приложения. +Если же вы используете модуль для [версионирования API](rest-versioning.md), URL правила необходимо добавлять +непосредственно в конфигурации `urlManager` приложения. ### Получение доступа к модулям