Skip to content

[ENQUEUE] Precise phpdoc for static analysis #1306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2023
Merged

[ENQUEUE] Precise phpdoc for static analysis #1306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions pkg/enqueue/Client/CommandSubscriberInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

namespace Enqueue\Client;

/**
* @phpstan-type CommandConfig = array{
* command: string,
* processor?: string,
* queue?: string,
* prefix_queue?: bool,
* exclusive?: bool,
* }
*/
interface CommandSubscriberInterface
{
/**
Expand Down Expand Up @@ -44,6 +53,8 @@ interface CommandSubscriberInterface
* Note: If you set "prefix_queue" to true then the "queue" is used as is and therefor the driver is not used to create a transport queue name.
*
* @return string|array
*
* @phpstan-return string|CommandConfig|array<CommandConfig>
*/
public static function getSubscribedCommand();
}