start-hello.md 11.1 KB
Newer Older
Anton A committed
1
Говорим «Привет»
2
================
Anton A committed
3

4 5
В этом разделе рассмотрим как создать новую страницу с надписью «Привет». В процессе решения задачи вы создадите
[действие контроллера](structure-controllers.md) и [представление](structure-views.md):
Anton A committed
6

7
* Приложение обработает запрос и передаст управление соответствующему действию;
Anton A committed
8 9 10 11 12
* Действие, в свою очередь, отобразит представление с надписью "Привет" конечному пользователю.

С помощью данного руководства вы изучите

* Как создавать [действие](structure-controllers.md), чтобы отвечать на запросы;
13
* Как создавать [представление](structure-views.md), чтобы формировать содержимое ответа;
Anton A committed
14 15 16 17
* Как приложение отсылает запросы к [действию](structure-controllers.md).


Создание Действия <a name="creating-action"></a>
18
------------------------------------------------
Anton A committed
19

20 21 22
Для нашей задачи потребуется [действие](structure-controllers.md) `say`, которое читает параметр `message` из
запроса и отображает его значение пользователю. Если в запросе не содержится параметра `message`, то действие будет
выводить «Привет».
Anton A committed
23

24 25
> Информация: [Действия](structure-controllers.md) могут быть запущены непосредственно пользователем и сгруппированы в
  [контроллеры](structure-controllers.md). Результатом выполнения действия является ответ, который получает пользователь.
Anton A committed
26

27 28
Действия объявляются в [контроллерах](structure-controllers.md). Для простоты, вы можете объявить действие
`say` в уже существующем контроллере `SiteController`, который определен в файле класса `controllers/SiteController.php`:
Anton A committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

```php
<?php

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
    // ...существующий код...

    public function actionSay($message = 'Привет')
    {
        return $this->render('say', ['message' => $message]);
    }
}
```

В приведенном коде действие `say` объявлено как метод `actionSay` в классе `SiteController`.
49 50
Yii использует префикс `action` чтобы различать методы-действия и обычные методы. Название после префикса `action`
считается идентификатором соответствующего действия.
Anton A committed
51

52 53 54 55
> Информация: Идентификаторы действий задаются в нижнем регистре. Если идентификатор состоит из нескольких слов, они
  соединяются дефисами, то есть `create-comment`. Имена методов действий получаются путём удаления дефисов
  из идентификатора, преобразования первой буквы каждого слова в верхний регистр и добавления префикса `action`.
  Например, идентификатор действия `create-comment` соответствует методу `actionCreateComment`.
Anton A committed
56

57 58
Метод действия принимает параметр `$message`, который по умолчанию равен `"Привет"`. Когда приложение получает запрос
и определяет, что действие `say` ответственно за его обработку, параметр заполняется одноимённым значением из запроса.
Anton A committed
59

60 61 62
Внутри метода действия, для вывода отображения [представления](structure-views.md) с именем `say`, используется метод
[[yii\web\Controller::render()|render()]]. Для того, чтобы вывести сообщение, в отображение передаётся параметр `message`.
Результат отображения при помощи `return` передаётся приложению, которое отдаёт его пользователю.
Anton A committed
63 64


65 66
Создание представления <a name="creating-view"></a>
---------------------------------------------------
Anton A committed
67

68 69
[Представления](structure-views.md) являются скриптами, которые используются для формирования тела ответа. Для нашего
приложения вы создадите представление `say`, которое будет выводить параметр `message`, полученный из метода действия:
Anton A committed
70 71 72 73 74 75 76 77 78

```php
<?php
use yii\helpers\Html;
?>
<?= Html::encode($message) ?>
```

Представление `say` должно быть сохранено в файле `views/site/say.php`. Когда метод [[yii\web\Controller::render()|render()]]
79
вызывается в действии, он будет искать PHP файл с именем вида `views/ControllerID/ActionID/ViewName.php`.
Anton A committed
80

81 82
Стоит отметить, что в коде выше параметр `message` [[yii\helpers\Html::encode()|экранируется для HTML]] перед выводом.
Это обязательно так как параметр приходит от пользователя, который может попытаться провести
Anton A committed
83
[XSS атаку](http://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D1%81%D0%B0%D0%B9%D1%82%D0%BE%D0%B2%D1%8B%D0%B9_%D1%81%D0%BA%D1%80%D0%B8%D0%BF%D1%82%D0%B8%D0%BD%D0%B3)
84
путём вставки зловредного JavaScript кода.
Anton A committed
85

86 87 88
Вы можете дополнить представление `say` HTML тегами, текстом или кодом PHP. Фактически, представление `say` является
простым PHP скриптом, который выполняется методом [[yii\web\Controller::render()|render()]]. Содержимое, выводимое
скриптом представления, будет передано пользователю приложением.
Anton A committed
89 90 91


Попробуем <a name="trying-it-out"></a>
92
--------------------------------------
Anton A committed
93 94 95 96

После создания действия и представления вы можете перейти на новую страницу по следующему URL:

```
97
http://hostname/index.php?r=site/say&message=Привет+мир
Anton A committed
98 99
```

100
![Привет, мир](images/start-hello-world.png)
Anton A committed
101

102 103 104
Будет отображена страница с надписью «Привет мир». Она использует ту же шапку и футер, что и остальные страницы приложения.
Если вы не укажете параметр `message`, то увидите на странице «Привет». Это происходит потому, как `message` передаётся
в метод `actionSay()` и значение по умолчанию — «Привет».
Anton A committed
105

106 107 108
> Информация: Новая страница использует ту же шапку и футер, что и другие страницы, потому что метод
  [[yii\web\Controller::render()|render()]] автоматически вставляет результат представления `say` в, так называемый, 
  [макет](structure-views.md) `views/layouts/main.php`.
Anton A committed
109

110 111 112 113 114 115
Параметр `r` требует дополнительных пояснений. Он связан с [маршрутом (route)](runtime-routing.md), который представляет
собой уникальный идентификатор, указывающий на действие. Его формат `ControllerID/ActionID`. Когда приложение получает
запрос, оно проверяет параметр `r` и, используя `ControllerID`, определяет какой контроллер следует использовать для
обработки запроса. Затем, контроллер использует часть `ActionID`, чтобы определить какое действие выполняет реальную работу.
В нашем случае маршрут `site/say` будет соответствовать контроллеру `SiteController` и его действию `say`. 
В результате, для обработки запроса будет вызван метод `SiteController::actionSay()`.
Anton A committed
116

117 118 119 120 121
> Информация: Как и действия, контроллеры также имеют идентификаторы, которые однозначно определяют их в приложении.
  Идентификаторы контроллеров используют те же правила именования, что и идентификаторы действий. Имена классов
  контроллеров получаются путём удаления дефисов из идентификатора, преобразования первой буквы каждого слова в
  верхний регистр и добавления в конец `Controller`. Например, идентификатор контроллера `post-comment` соответствует
  имени класса контроллера `PostCommentController`.
Anton A committed
122 123 124


Резюме <a name="summary"></a>
125
-----------------------------
Anton A committed
126

127 128 129
В этом разделе вы затронули тему контроллеров и представлений в паттерне MVC. Вы создали действие как часть контроллера,
обрабатывающего запросы, и представление, участвующее в формировании ответа. В этом процессе никак не была задействована
модель, так как в качестве данных выступает лишь простой параметр `message`.
Anton A committed
130

131 132 133 134
Также вы познакомились с концепцией маршрутизации, которая является связующим звеном между запросом пользователя и
действием контроллера.

В следующем разделе вы узнаете как создавать модели и добавлять новые страницы с HTML формами.
Anton A committed
135