Skip to content

Commit 1cbdcaa

Browse files
zhuravljovzhuravljov
committed
Updated docs [ci skip]
1 parent ecbfe31 commit 1cbdcaa

16 files changed

Lines changed: 159 additions & 37 deletions

‎docs/guide-ru/debug.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22
=======
33

44
Для удобств разработки в отладочный модуль Yii2 можно добавить панель, которая будет выводить список
5-
поставленных в очередь заданий и их количество.
5+
поставленных в очередь заданий, их количество и состояние.
66

77
Отладочное расширение `yiisoft/yii2-debug` должно быть установлено в Вашем приложении.
88

99
Настройка приложения:
1010

1111
```php
1212
return [
13-
'bootstrap' => ['debug', 'queue'],
1413
'modules' => [
1514
'debug' => [
1615
'class' => \yii\debug\Module::class,

‎docs/guide-ru/driver-amqp.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ RabbitMQ драйвер
99

1010
```php
1111
return [
12-
'bootstrap' => ['queue'],
12+
'bootstrap' => [
13+
'queue', // Компонент регистрирует свои консольные команды
14+
],
1315
'components' => [
1416
'queue' => [
1517
'class' => \zhuravljov\yii\queue\amqp\Queue::class,
@@ -35,3 +37,9 @@ yii queue/listen
3537
Команда `listen` запускает обработку очереди в режиме демона. Очередь опрашивается непрерывно.
3638
Если добавляются новые задания, то они сразу же извлекаются и выполняются. Способ наиболее эфективен
3739
если запускать команду через демон-супервизор, например `supervisord`.
40+
41+
Для команды `listen` доступны следующие опции:
42+
43+
- `--verbose`, `-v`: состояние обработки заданий выводится в консоль.
44+
- `--isolate`: каждое задание выполняется в отдельном дочернем процессе.
45+
- `--color`: подсветка вывода в режиме `--verbose`.

‎docs/guide-ru/driver-beanstalk.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Beanstalk драйвер
77

88
```php
99
return [
10-
'bootstrap' => ['queue'],
10+
'bootstrap' => [
11+
'queue', // Компонент регистрирует свои консольные команды
12+
],
1113
'components' => [
1214
'queue' => [
1315
'class' => \zhuravljov\yii\queue\beanstalk\Queue::class,
@@ -19,7 +21,10 @@ return [
1921
];
2022
```
2123

22-
Для выполнения задач используются консольные команды.
24+
Консоль
25+
-------
26+
27+
Для обратки очереди используются консольные команды.
2328

2429
```bash
2530
yii queue/run
@@ -36,6 +41,12 @@ yii queue/listen
3641
Если добавляются новые задания, то они сразу же извлекаются и выполняются. Способ наиболее эфективен
3742
если запускать команду через демон-супервизор, например `supervisord`.
3843

44+
Для команд `run` и `listen` доступны следующие опции:
45+
46+
- `--verbose`, `-v`: состояние обработки заданий выводится в консоль.
47+
- `--isolate`: каждое задание выполняется в отдельном дочернем процессе.
48+
- `--color`: подсветка вывода в режиме `--verbose`.
49+
3950
```bash
4051
yii queue/info
4152
```

‎docs/guide-ru/driver-db.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ DB дравер для хранения очереди заданий испол
77

88
```php
99
return [
10-
'bootstrap' => ['queue'],
10+
'bootstrap' => [
11+
'queue', // Компонент регистрирует свои консольные команды
12+
],
1113
'components' => [
1214
'queue' => [
1315
'class' => \zhuravljov\yii\queue\db\Queue::class,
@@ -42,7 +44,7 @@ CREATE TABLE `queue` (
4244
Консоль
4345
-------
4446

45-
Для выполнения задач также используются консольные команды.
47+
Для обратки очереди используются консольные команды.
4648

4749
```bash
4850
yii queue/run
@@ -60,6 +62,12 @@ yii queue/listen [delay]
6062
в секундах перед следующим опросом очереди. Способ наиболее эфективен если запускать команду через
6163
демон-супервизор, например `supervisord`.
6264

65+
Для команд `run` и `listen` доступны следующие опции:
66+
67+
- `--verbose`, `-v`: состояние обработки заданий выводится в консоль.
68+
- `--isolate`: каждое задание выполняется в отдельном дочернем процессе.
69+
- `--color`: подсветка вывода в режиме `--verbose`.
70+
6371
```bash
6472
yii queue/info
6573
```

‎docs/guide-ru/driver-file.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ DB дравер для хранения очереди заданий испол
77

88
```php
99
return [
10-
'bootstrap' => ['queue'],
10+
'bootstrap' => [
11+
'queue', // Компонент регистрирует свои консольные команды
12+
],
1113
'components' => [
1214
'queue' => [
1315
'class' => \zhuravljov\yii\queue\file\Queue::class,
@@ -20,7 +22,7 @@ return [
2022
Консоль
2123
-------
2224

23-
Для выполнения задач также используются консольные команды.
25+
Для обратки очереди используются консольные команды.
2426

2527
```bash
2628
yii queue/run
@@ -38,6 +40,12 @@ yii queue/listen [delay]
3840
в секундах перед следующим опросом очереди. Способ наиболее эфективен если запускать команду через
3941
демон-супервизор, например `supervisord`.
4042

43+
Для команд `run` и `listen` доступны следующие опции:
44+
45+
- `--verbose`, `-v`: состояние обработки заданий выводится в консоль.
46+
- `--isolate`: каждое задание выполняется в отдельном дочернем процессе.
47+
- `--color`: подсветка вывода в режиме `--verbose`.
48+
4149
```bash
4250
yii queue/info
4351
```

‎docs/guide-ru/driver-gearman.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Gearman драйвер
77

88
```php
99
return [
10-
'bootstrap' => ['queue'],
10+
'bootstrap' => [
11+
'queue', // Компонент регистрирует свои консольные команды
12+
],
1113
'components' => [
1214
'queue' => [
1315
'class' => \zhuravljov\yii\queue\gearman\Queue::class,
@@ -38,3 +40,9 @@ yii queue/listen
3840
Команда `listen` запускает обработку очереди в режиме демона. Очередь опрашивается непрерывно.
3941
Если добавляются новые задания, то они сразу же извлекаются и выполняются. Способ наиболее эфективен
4042
если запускать команду через демон-супервизор, например `supervisord`.
43+
44+
Для команд `run` и `listen` доступны следующие опции:
45+
46+
- `--verbose`, `-v`: состояние обработки заданий выводится в консоль.
47+
- `--isolate`: каждое задание выполняется в отдельном дочернем процессе.
48+
- `--color`: подсветка вывода в режиме `--verbose`.

‎docs/guide-ru/driver-redis.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99

1010
```php
1111
return [
12-
'bootstrap' => ['queue'],
12+
'bootstrap' => [
13+
'queue', // Компонент регистрирует свои консольные команды
14+
],
1315
'components' => [
1416
'queue' => [
1517
'class' => \zhuravljov\yii\queue\redis\Queue::class,
@@ -20,7 +22,10 @@ return [
2022
];
2123
```
2224

23-
Для выполнения задач используются консольные команды.
25+
Консоль
26+
-------
27+
28+
Для обратки очереди используются консольные команды.
2429

2530
```bash
2631
yii queue/run
@@ -37,6 +42,12 @@ yii queue/listen
3742
Если добавляются новые задания, то они сразу же извлекаются и выполняются. Способ наиболее эфективен
3843
если запускать команду через демон-супервизор, например `supervisord`.
3944

45+
Для команд `run` и `listen` доступны следующие опции:
46+
47+
- `--verbose`, `-v`: состояние обработки заданий выводится в консоль.
48+
- `--isolate`: каждое задание выполняется в отдельном дочернем процессе.
49+
- `--color`: подсветка вывода в режиме `--verbose`.
50+
4051
```bash
4152
yii queue/info
4253
```

‎docs/guide-ru/usage.md‎

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
```php
1111
return [
12+
'bootstrap' => [
13+
'queue', // Компонент регистрирует свои консольные команды
14+
],
1215
'components' => [
1316
'queue' => [
1417
'class' => \zhuravljov\yii\queue\<driver>\Queue::class,
@@ -54,8 +57,6 @@ Yii::$app->queue->push(new DownloadJob([
5457
]));
5558
```
5659

57-
Способы выполнения задач могут различаться, и зависят от используемого в расширении драйвера.
58-
5960
Отправить задание для выполнения с задержкой в 5 минут:
6061

6162
```php
@@ -69,6 +70,14 @@ Yii::$app->queue->later(new DownloadJob([
6970
в отладочных целях, обрабатывает `later()` как обычный `push()`.
7071

7172

73+
Обработка очереди
74+
-----------------
75+
76+
Способы обработки очереди задач могут различаться, и зависят от используемого драйвера. В большей
77+
части драйверов воркеры запускаются с помощью консольных команд, которые компонент сам регистрирует
78+
в приложении. Детальное описание смотрите в документации конкретного драйвера.
79+
80+
7281
Статус заданий
7382
--------------
7483

@@ -88,7 +97,7 @@ Yii::$app->queue->isReserved($id);
8897
Yii::$app->queue->isDone($id);
8998
```
9099

91-
**Внимание:** Драйвер для RebbitMQ не поддерживает статусы.
100+
**Внимание:** Драйвер RebbitMQ не поддерживает статусы.
92101

93102

94103
Сообщения для сторонних воркеров
@@ -104,7 +113,7 @@ Yii::$app->queue->push([
104113
]);
105114
```
106115

107-
Это допустимо, если очередь обрабатывается сторонним воркером, разработанным специально.
116+
Это допустимо, если очередь обрабатывается сторонним воркером, разработанным индивидуально.
108117

109118
Если воркер разрабатыватеся не на PHP, то, также, необходимо изменить способ сериализации данных,
110119
чтобы сообщения кодировались доступным воркеру форматом. Например, настроить сериализацию в json,
@@ -130,8 +139,8 @@ return [
130139
```php
131140
return [
132141
'bootstrap' => [
133-
'queue1',
134-
'queue2',
142+
'queue1', // Первый компонент регистрирует свои консольные команды
143+
'queue2', // Второй - свои
135144
],
136145
'components' => [
137146
'queue1' => [
@@ -166,12 +175,12 @@ Yii::$app->queue2->push([
166175
Ограничения
167176
-----------
168177

169-
Используя очереди важно помнить, что задачи ставятся в очередь и извлекаются из нее в разных
170-
процессах. Поэтому, при обработке задания, избегайте использования внешних зависимостей, когда
171-
не уверены в том, что они будут доступны в том окружении, где работает воркер.
178+
Используя очереди важно помнить, что задачи ставятся и извлекаются из очереди в разных процессах.
179+
Поэтому, при обработке задания, избегайте использования внешних зависимостей, когда не уверены
180+
в том, что они будут доступны в окружении, где работает воркер.
172181

173-
Все данные, необходимые для выполнения задания, нужно оформлять в виде свойств Вашего job-объекта, и
174-
отправлять в очередь вместе с ним.
182+
Все данные, необходимые для выполнения задания, нужно оформлять в виде свойств Вашего job-объекта,
183+
и отправлять в очередь вместе с ним.
175184

176185
Если в задании нужно работать с моделью `ActiveRecord`, вместо самой модели передавайте ее ID. А в
177186
момент выполнения извлекайте ее из базы данных.

‎docs/guide/debug.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Configure your application like the following:
1010

1111
```php
1212
return [
13-
'bootstrap' => ['debug', 'queue'],
1413
'modules' => [
1514
'debug' => [
1615
'class' => \yii\debug\Module::class,

‎docs/guide/driver-amqp.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Configuration example:
99

1010
```php
1111
return [
12-
'bootstrap' => ['queue'],
12+
'bootstrap' => [
13+
'queue', // The component registers own console commands
14+
],
1315
'components' => [
1416
'queue' => [
1517
'class' => \zhuravljov\yii\queue\amqp\Queue::class,
@@ -35,3 +37,9 @@ yii queue/listen
3537
`listen` command launches a daemon which infinitely queries the queue. If there are new tasks they're immediately
3638
obtained and executed. This method is most effificient when command is properly daemonized via supervisor such as
3739
`supervisord`.
40+
41+
`listen` command has options:
42+
43+
- `--verbose`, `-v`: print executing statuses into console.
44+
- `--isolate`: verbose mode of a job execute. If enabled, execute result of each job will be printed.
45+
- `--color`: highlighting for verbose mode.

0 commit comments

Comments
 (0)