diff --git a/src/Queue/Concerns/UsesCommand.php b/src/Queue/Concerns/UsesCommand.php index a3308ddc..1b49d145 100644 --- a/src/Queue/Concerns/UsesCommand.php +++ b/src/Queue/Concerns/UsesCommand.php @@ -6,6 +6,12 @@ use Illuminate\Console\Command; +/** + * Implementations of UsesCommandInterface. Use this trait to access the command output and other properties. when the + * job is executed by the RunJobActionContract (not in queue). + * + * @see \LaraStrict\Queue\Interfaces\UsesCommandInterface + */ trait UsesCommand { private ?Command $command = null; diff --git a/src/Queue/Interfaces/UsesCommandInterface.php b/src/Queue/Interfaces/UsesCommandInterface.php index 9613540b..1326b179 100644 --- a/src/Queue/Interfaces/UsesCommandInterface.php +++ b/src/Queue/Interfaces/UsesCommandInterface.php @@ -7,12 +7,16 @@ use Illuminate\Console\Command; /** - * Implementations of UsesCommand trait + * Use this interface to access the command output and other properties with combination with UsesCommand trait. * - * @see \LaraStrict\Queue\Concerns\UsesCommand + * @see \LaraStrict\Queue\Interfaces\UsesCommandInterface */ interface UsesCommandInterface { + /** + * Command is set when the job is executed by the RunJobActionContract (not in queue). You can use this to access + * the command output and other properties. + */ public function setCommand(Command $command): void; public function getCommand(): ?Command;