Skip to content

Commit aee4f72

Browse files
committed
Fix queue:listen-all command name
1 parent 604f2c0 commit aee4f72

4 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ final readonly class Foo {
117117
}
118118
```
119119

120-
### 5. Handle queue messages
120+
### 5. Handle queued messages
121121

122122
By default, Yii Framework uses [yiisoft/yii-console](https://github.com/yiisoft/yii-console) to run CLI commands. If you installed [yiisoft/app](https://github.com/yiisoft/app) or [yiisoft/app-api](https://github.com/yiisoft/app-api), you can run the queue worker with on of these two commands:
123123

@@ -233,7 +233,7 @@ yii queue:listen [channel]
233233
The following command iterates through multiple channels and is meant to be used in development environment only:
234234
235235
```sh
236-
yii queue:listen:all [channel1 [channel2 [...]]] --pause=1 --maximum=0
236+
yii queue:listen-all [channel1 [channel2 [...]]] --pause=1 --maximum=0
237237
```
238238
239239
For long-running processes, graceful shutdown is controlled by `LoopInterface`. When `ext-pcntl` is available,

config/params.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
'commands' => [
1919
'queue:run' => RunCommand::class,
2020
'queue:listen' => ListenCommand::class,
21+
'queue:listen-all' => ListenAllCommand::class,
2122
'queue:listen:all' => ListenAllCommand::class,
2223
],
2324
],

docs/guide/en/console-commands.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,7 @@ The full command signature is:
4141
yii queue:listen-all [channel1 [channel2 [...]]] --pause=1 --maximum=0
4242
```
4343
44+
> The command alias `queue:listen:all` is deprecated and will be removed in `1.0.0`, since it was a typo.
45+
4446
For long-running processes, graceful shutdown is controlled by `LoopInterface`. When `ext-pcntl` is available,
4547
the default `SignalLoop` handles signals such as `SIGTERM`/`SIGINT`.

src/Command/ListenAllCommand.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
'Listens the all the given queues and executes messages as they come. '
1919
. 'Meant to be used in development environment only. '
2020
. 'Listens all configured queues by default in case you\'re using yiisoft/config. '
21-
. 'Needs to be stopped manually.'
21+
. 'Needs to be stopped manually.',
22+
['queue:listen:all'],
2223
)]
2324
final class ListenAllCommand extends Command
2425
{

0 commit comments

Comments
 (0)