Documentation #250

viktorprogger · 2025-12-13T10:21:35Z

Q	A
Is bugfix?	✔️
New feature?	❌
Breaks BC?	❌

codecov · 2025-12-13T13:20:23Z

Codecov Report

❌ Patch coverage is 83.33333% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.88%. Comparing base (493a753) to head (eb27a90).

Files with missing lines	Patch %	Lines
src/Worker/Worker.php	83.33%	8 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #250      +/-   ##
============================================
- Coverage     98.59%   97.88%   -0.72%     
- Complexity      356      362       +6     
============================================
  Files            47       47              
  Lines           927      945      +18     
============================================
+ Hits            914      925      +11     
- Misses           13       20       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

samdark · 2025-12-14T10:39:15Z

docs/guide/en/configuration-with-config.md

+
+- Optionally: define default `\Yiisoft\Queue\Adapter\AdapterInterface` implementation.
+- And/or define channel-specific `AdapterInterface` implementations in the `channels` params key to be used
+  with the [queue provider](usage.md#different-queue-channels).


There's nothing in usage.md about queue provider and there's no such anchor as well.

samdark · 2025-12-14T10:39:31Z

docs/guide/en/configuration-with-config.md

+
+## Where to put the configuration
+
+In `yiisoft/app` / `yiisoft/app-api` templates you typically add or adjust configuration in `config/params.php`.


Worth linking package names everywhere.

samdark · 2025-12-14T10:40:20Z

docs/guide/en/message-handler.md

+
+Handler definitions are configured in:
+
+- `$params['yiisoft/queue']['handlers']` when using `yiisoft/config`, or


Worth linking yiisoft/config package.

samdark · 2025-12-14T10:41:26Z

docs/guide/en/message-handler.md

+
+- Another application pushes messages to the same broker.
+- A different language/runtime produces messages.
+- You want a stable public contract that is independent from your PHP namespaces and refactorings.


Suggested change

- You want a stable public contract that is independent from your PHP namespaces and refactorings.

- You want a stable public contract that is independent of your PHP namespaces and refactorings.

samdark · 2025-12-14T10:42:22Z

docs/guide/en/message-handler.md

+
+## When mapping by short names is a better idea
+
+While FQCN-as-name is convenient inside a single application, mapping by a short name is often a better contract when messages are produced outside of the current codebase, or when you want to create a stable public API for inter-service communication.


Suggested change

While FQCN-as-name is convenient inside a single application, mapping by a short name is often a better contract when messages are produced outside of the current codebase, or when you want to create a stable public API for inter-service communication.

While FQCN-as-name is convenient inside a single application, mapping by a short name is often a better contract. That is true when messages are produced outside the current codebase, or when you want to create a stable public API for inter-service communication.

samdark · 2025-12-14T10:43:02Z

docs/guide/en/message-handler.md

+
+## Config location (yiisoft/config)
+
+When using `yiisoft/config`, configure handlers under the `yiisoft/queue` params key:


Worth linking package names.

samdark · 2025-12-14T10:44:19Z

README.md

+
+### 4. Send (produce/push) a message to a queue
+
+To send a message to the queue, you need to get the queue instance and call the `push()` method. Typically with Yii Framework you'll get a `Queue` instance as a dependency of a service.


Suggested change

To send a message to the queue, you need to get the queue instance and call the `push()` method. Typically with Yii Framework you'll get a `Queue` instance as a dependency of a service.

To send a message to the queue, you need to get the queue instance and call the `push()` method. Typically, with Yii Framework you'll get a `Queue` instance as a dependency of a service.

samdark · 2025-12-14T10:44:28Z

README.md

+
+### 5. Handle queue messages
+
+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:


Suggested change

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:

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:

samdark · 2025-12-14T10:44:44Z

README.md

+./yii queue:listen # Start a daemon listening for new messages permanently
+```
+
+> In case you're using the SynchronosAdapter for development purposes, you should not use these commands, as you have no asynchronous processing available. The messages are processed immediately when pushed.


Suggested change

> In case you're using the SynchronosAdapter for development purposes, you should not use these commands, as you have no asynchronous processing available. The messages are processed immediately when pushed.

> In case you're using the `SynchronosAdapter` for development purposes, you should not use these commands, as you have no asynchronous processing available. The messages are processed immediately when pushed.

viktorprogger and others added 2 commits December 13, 2025 15:20

Start docs refining

745b353

Apply fixes from StyleCI

eb27a90

viktorprogger changed the title ~~Start docs refining~~ Documentation Dec 13, 2025

samdark reviewed Dec 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Documentation #250

Documentation #250

Uh oh!

viktorprogger commented Dec 13, 2025

Uh oh!

codecov bot commented Dec 13, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

samdark Dec 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		## Where to put the configuration

		In `yiisoft/app` / `yiisoft/app-api` templates you typically add or adjust configuration in `config/params.php`.


		Handler definitions are configured in:

		- `$params['yiisoft/queue']['handlers']` when using `yiisoft/config`, or

	- You want a stable public contract that is independent from your PHP namespaces and refactorings.
	- You want a stable public contract that is independent of your PHP namespaces and refactorings.


		## When mapping by short names is a better idea

		While FQCN-as-name is convenient inside a single application, mapping by a short name is often a better contract when messages are produced outside of the current codebase, or when you want to create a stable public API for inter-service communication.


		## Config location (yiisoft/config)

		When using `yiisoft/config`, configure handlers under the `yiisoft/queue` params key:


		### 4. Send (produce/push) a message to a queue

		To send a message to the queue, you need to get the queue instance and call the `push()` method. Typically with Yii Framework you'll get a `Queue` instance as a dependency of a service.


		### 5. Handle queue messages

		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:

	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:
	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:

	> In case you're using the SynchronosAdapter for development purposes, you should not use these commands, as you have no asynchronous processing available. The messages are processed immediately when pushed.
	> In case you're using the `SynchronosAdapter` for development purposes, you should not use these commands, as you have no asynchronous processing available. The messages are processed immediately when pushed.

Uh oh!

Documentation #250

Are you sure you want to change the base?

Documentation #250

Uh oh!

Conversation

viktorprogger commented Dec 13, 2025

Uh oh!

codecov bot commented Dec 13, 2025

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants