Spec-Zone.ru › Laravel 11

QueueFake

class QueueFake extends QueueManager implements Fake, Queue (View source)

Свойства

ReflectsClosures

Свойства

protected Application $app

Экземпляр приложения.

from QueueManager
protected array $connections

Массив подключений к очереди.

from QueueManager
protected array $connectors

Массив подключенных к очереди коннекторов.

from QueueManager
Queue $queue

Исходный менеджер очереди.

protected Collection $jobsToFake

Типы задач, которые должны быть перехвачены вместо отправки в очередь.

protected Collection $jobsToBeQueued

Типы задач, которые должны быть отправлены в очередь и не перехвачены.

protected array $jobs

Все задачи, которые были отправлены.

protected bool $serializeAndRestore

Указывает, должны ли элементы сериализоваться и восстанавливаться при отправке в очередь.

Методы

void __construct(Application $app, array $jobsToFake = [], QueueManager|null $queue = null)

Создать новый экземпляр фиктивной очереди.

void before(mixed $callback)

Зарегистрировать обработчик событий для события перед задачей.

из QueueManager
void after(mixed $callback)

Зарегистрировать обработчик событий для события после задачи.

из QueueManager
void exceptionOccurred(mixed $callback)

Зарегистрировать обработчик событий для события возникновения исключения в задаче.

из QueueManager
void looping(mixed $callback)

Зарегистрировать обработчик событий для цикла очереди демона.

из QueueManager
void failing(mixed $callback)

Зарегистрировать обработчик событий для события неудачной задачи.

из QueueManager
void stopping(mixed $callback)

Зарегистрировать обработчик событий для остановки очереди демона.

из QueueManager
bool connected(string|null $name = null)

Определить, подключен ли драйвер.

из QueueManager
Queue connection(mixed $value = null)

Получить экземпляр подключения к очереди.

Queue resolve(string $name)

Разрешить подключение к очереди.

из QueueManager
ConnectorInterface getConnector(string $driver)

Получить соединитель для заданного драйвера.

из QueueManager
void extend(string $driver, Closure $resolver)

Добавить решатель подключения к очереди.

из QueueManager
void addConnector(string $driver, Closure $resolver)

Добавить решатель подключения к очереди.

из QueueManager
array|null getConfig(string $name)

Получить конфигурацию подключения к очереди.

из QueueManager
string getDefaultDriver()

Получить имя подключения к очереди по умолчанию.

из QueueManager
void setDefaultDriver(string $name)

Установить имя подключения к очереди по умолчанию.

из QueueManager
string getName(string|null $connection = null)

Получить полное имя для данного подключения.

из QueueManager
Application getApplication()

Получить экземпляр приложения, используемый менеджером.

из QueueManager
$this setApplication(Application $app)

Установить экземпляр приложения, используемый менеджером.

из QueueManager
mixed __call(string $method, array $parameters)

Переопределить QueueManager для предотвращения циклической зависимости.

string firstClosureParameterType(Closure $closure)

Получить имя класса первого параметра данного замыкания.

из ReflectsClosures
array firstClosureParameterTypes(Closure $closure)

Получить имена классов первого параметра данного замыкания, включая объединенные типы.

из ReflectsClosures
array closureParameterTypes(Closure $closure)

Получить имена/типы классов параметров данного замыкания.

из ReflectsClosures
$this except(array|string $jobsToBeQueued)

Указать задачи, которые должны быть поставлены в очередь вместо фиктивных.

void assertPushed(string|Closure $job, callable|int|null $callback = null)

Утверждать, что задача была отправлена на основе обратного вызова проверки истинности.

void assertPushedTimes(string $job, int $times = 1)

Утверждать, что задача была отправлена определенное количество раз.

void assertPushedOn(string $queue, string|Closure $job, callable|null $callback = null)

Утверждать, что задача была отправлена на основе обратного вызова проверки истинности.

void assertPushedWithChain(string $job, array $expectedChain = [], callable|null $callback = null)

Утверждать, что задача была отправлена с присоединенными задачами на основе обратного вызова проверки истинности.

void assertPushedWithoutChain(string $job, callable|null $callback = null)

Утверждать, что задача была отправлена с пустой цепочкой на основе обратного вызова проверки истинности.

void assertPushedWithChainOfObjects(string $job, array $expectedChain, callable|null $callback)

Утверждать, что задача была отправлена с присоединенными задачами на основе обратного вызова проверки истинности.

END_OF_DOCUMENT_MARKER
void assertPushedWithChainOfClasses(string $job, array $expectedChain, callable|null $callback)

Проверить, был ли задан job с цепочкой задач на основе обратного вызова.

void assertClosurePushed(callable|int|null $callback = null)

Проверить, был ли задан замыкание на основе обратного вызова.

void assertClosureNotPushed(callable|null $callback = null)

Проверить, что замыкание не было задано на основе обратного вызова.

bool isChainOfObjects(array $chain)

Определить, состоит ли данная цепочка полностью из объектов.

void assertNotPushed(string|Closure $job, callable|null $callback = null)

Определить, был ли задан job на основе обратного вызова.

void assertCount(int $expectedCount)

Проверить общее количество заданных задач.

void assertNothingPushed()

Проверить, что задачи не задавались.

Collection pushed(string $job, callable|null $callback = null)

Получить все задачи, соответствующие обратному вызову.

bool hasPushed(string $job)

Определить, есть ли сохранённые задачи для данного класса.

int size(string|null $queue = null)

Получить размер очереди.

mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Добавить новую задачу в очередь.

bool shouldFakeJob(object $job)

Определить, должна ли задача быть смоделирована или фактически отправлена.

bool shouldDispatchJob(object $job)

Определить, должна ли задача быть отправлена в очередь, а не смоделирована.

mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Добавить сырой payload в очередь.

mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Добавить новую задачу в очередь после (n) секунд.

mixed pushOn(string $queue, string|object $job, mixed $data = '')

Добавить новую задачу в очередь.

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '')

Добавить новую задачу в определённую очередь после (n) секунд.

Job|null pop(string|null $queue = null)

Извлечь следующую задачу из очереди.

mixed bulk(array $jobs, mixed $data = '', string|null $queue = null)

Добавить массив задач в очередь.

array pushedJobs()

Получить заданные задачи.

$this serializeAndRestore(bool $serializeAndRestore = true)

Указать, должны ли задачи сериализоваться и восстанавливаться при добавлении в очередь.

mixed serializeAndRestoreJob(mixed $job)

Сериализовать и десериализовать задачу, чтобы смоделировать процесс очереди.

string getConnectionName()

Получить имя соединения для очереди.

$this setConnectionName(string $name)

Установить имя соединения для очереди.

Details

void __construct(Application $app, array $jobsToFake = [], QueueManager|null $queue = null)

Создать новый фейковый экземпляр очереди.

Parameters

Application $app
array $jobsToFake
QueueManager|null $queue

Return Value

void

void before(mixed $callback)

Зарегистрировать обработчик события перед задачей.

Parameters

mixed $callback

Return Value

void

void after(mixed $callback)

Зарегистрировать обработчик события после задачи.

Parameters

mixed $callback

Return Value

void

void exceptionOccurred(mixed $callback)

Зарегистрировать обработчик события возникновения исключения в задаче.

Parameters

mixed $callback

Return Value

void

void looping(mixed $callback)

Зарегистрировать обработчик события цикла демона очереди.

Parameters

mixed $callback

Return Value

void

void failing(mixed $callback)

Зарегистрировать обработчик события отказа задачи.

Parameters

mixed $callback

Return Value

void

void stopping(mixed $callback)

Зарегистрировать обработчик события остановки демона очереди.

Parameters

mixed $callback

Return Value

void

bool connected(string|null $name = null)

Определить, подключено ли соединение.

Parameters

string|null $name

Return Value

bool
END_OF_DOCUMENT_MARKER

Очередь connection(mixed $value = null)

Резолвинг экземпляра подключения к очереди.

Параметры

mixed $value

Возвращаемое значение

Очередь

protected Очередь resolve(string $name)

Резолвинг подключения к очереди.

Параметры

string $name

Возвращаемое значение

Очередь

Исключения

InvalidArgumentException

protected Интерфейс подключения getConnector(string $driver)

Получение интерфейса подключения для указанного драйвера.

Параметры

string $driver

Возвращаемое значение

Интерфейс подключения

Исключения

InvalidArgumentException

void extend(string $driver, Closure $resolver)

Добавление резолвера подключения к очереди.

Параметры

string $driver
Closure $resolver

Возвращаемое значение

void

void addConnector(string $driver, Closure $resolver)

Добавление резолвера подключения к очереди.

Параметры

string $driver
Closure $resolver

Возвращаемое значение

void

protected array|null getConfig(string $name)

Получение конфигурации подключения к очереди.

Параметры

string $name

Возвращаемое значение

array|null

string getDefaultDriver()

Получение имени драйвера по умолчанию для очереди.

Возвращаемое значение

string

void setDefaultDriver(string $name)

Установление имени драйвера по умолчанию для очереди.

Параметры

string $name

Возвращаемое значение

void

string getName(string|null $connection = null)

Получение полного имени для указанного подключения.

Параметры

string|null $connection

Возвращаемое значение

string

Приложение getApplication()

Получение экземпляра приложения, используемого менеджером.

Возвращаемое значение

Приложение

$this setApplication(Приложение $app)

Установление экземпляра приложения, используемого менеджером.

Параметры

Приложение $app

Возвращаемое значение

$this

mixed __call(string $method, array $parameters)

Переопределение QueueManager для предотвращения циклической зависимости.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

protected string firstClosureParameterType(Closure $closure)

Получение имени класса первого параметра данного Closure.

Параметры

Closure $closure

Возвращаемое значение

string

Исключения

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

Получение имён классов первого параметра данного Closure, включая типы объединения.

Параметры

Closure $closure

Возвращаемое значение

array

Исключения

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

Получение имён классов/типов параметров данного Closure.

Параметры

Closure $closure

Возвращаемое значение

array

Исключения

ReflectionException

$this except(array|string $jobsToBeQueued)

Указать задачи, которые должны быть помещены в очередь вместо имитации.

Параметры

array|string $jobsToBeQueued

Возвращаемое значение

$this

void assertPushed(string|Closure $job, callable|int|null $callback = null)

Утверждать, что задача была отправлена на основе обратного вызова проверки истинности.

Параметры

string|Closure $job
callable|int|null $callback

Возвращаемое значение

void

protected void assertPushedTimes(string $job, int $times = 1)

Утверждать, что задача была отправлена определенное количество раз.

Параметры

string $job
int $times

Возвращаемое значение

void

void assertPushedOn(string $queue, string|Closure $job, callable|null $callback = null)

Утверждать, что задача была отправлена на основе обратного вызова проверки истинности.

Параметры

string $queue
string|Closure $job
callable|null $callback

Возвращаемое значение

void

void assertPushedWithChain(string $job, array $expectedChain = [], callable|null $callback = null)

Утверждать, что задача была отправлена с цепочкой задач на основе обратного вызова проверки истинности.

Параметры

string $job
array $expectedChain
callable|null $callback

Возвращаемое значение

void

void assertPushedWithoutChain(string $job, callable|null $callback = null)

Утверждать, что задача была отправлена с пустой цепочкой на основе обратного вызова проверки истинности.

Параметры

string $job
callable|null $callback

Возвращаемое значение

void

protected void assertPushedWithChainOfObjects(string $job, array $expectedChain, callable|null $callback)

Утверждать, что задача была отправлена с цепочкой задач на основе обратного вызова проверки истинности.

Параметры

string $job
array $expectedChain
callable|null $callback

Возвращаемое значение

void

protected void assertPushedWithChainOfClasses(string $job, array $expectedChain, callable|null $callback)

Утверждать, что задача была отправлена с цепочкой задач на основе обратного вызова проверки истинности.

Параметры

string $job
array $expectedChain
callable|null $callback

Возвращаемое значение

void

void assertClosurePushed(callable|int|null $callback = null)

Утверждать, что замыкание было отправлено на основе обратного вызова проверки истинности.

Параметры

callable|int|null $callback

Возвращаемое значение

void

void assertClosureNotPushed(callable|null $callback = null)

Утверждать, что замыкание не было отправлено на основе обратного вызова проверки истинности.

Параметры

callable|null $callback

Возвращаемое значение

void

protected bool isChainOfObjects(array $chain)

Определить, состоит ли заданная цепочка целиком из объектов.

Параметры

array $chain

Возвращаемое значение

bool

void assertNotPushed(string|Closure $job, callable|null $callback = null)

Определить, была ли задача отправлена на основе обратного вызова проверки истинности.

Параметры

string|Closure $job
callable|null $callback

Возвращаемое значение

void

void assertCount(int $expectedCount)

Утверждать общее количество задач, которые были отправлены.

Параметры

int $expectedCount

Возвращаемое значение

void

void assertNothingPushed()

Утверждать, что задачи не отправлялись.

Возвращаемое значение

void

Collection pushed(string $job, callable|null $callback = null)

Получить все задачи, соответствующие обратному вызову проверки истинности.

Параметры

string $job
callable|null $callback

Возвращаемое значение

Collection

bool hasPushed(string $job)

Определить, есть ли сохраненные задачи для данного класса.

Параметры

string $job

Возвращаемое значение

bool

int size(string|null $queue = null)

Получить размер очереди.

Параметры

string|null $queue

Возвращаемое значение

int

mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Отправить новую задачу в очередь.

Параметры

string|object $job
mixed $data
string|null $queue

Возвращаемое значение

mixed

bool shouldFakeJob(object $job)

Определить, должна ли быть заменена задача или фактически отправлена.

Параметры

object $job

Возвращаемое значение

bool

protected bool shouldDispatchJob(object $job)

Определить, должна ли задача быть отправлена в очередь вместо имитации.

Параметры

object $job

Возвращаемое значение

bool

mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Отправить сырые данные в очередь.

Параметры

string $payload
string|null $queue
array $options

Значение результата

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Отправить задачу в очередь через (n) секунд.

Параметры

DateTimeInterface|DateInterval|int $delay
string|object $job
mixed $data
string|null $queue

Значение результата

mixed

mixed pushOn(string $queue, string|object $job, mixed $data = '')

Отправить новую задачу в очередь.

Параметры

string $queue
string|object $job
mixed $data

Значение результата

mixed

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '')

Отправить задачу в определённую очередь через (n) секунд.

Параметры

string $queue
DateTimeInterface|DateInterval|int $delay
string|object $job
mixed $data

Значение результата

mixed

Job|null pop(string|null $queue = null)

Извлечь следующую задачу из очереди.

Параметры

string|null $queue

Значение результата

Job|null

mixed bulk(array $jobs, mixed $data = '', string|null $queue = null)

Отправить массив задач в очередь.

Параметры

array $jobs
mixed $data
string|null $queue

Значение результата

mixed

array pushedJobs()

Получить отправленные задачи.

Значение результата

array

$this serializeAndRestore(bool $serializeAndRestore = true)

Указать, нужно ли сериализовать и восстанавливать задачи при отправке в очередь.

Параметры

bool $serializeAndRestore

Значение результата

$this

protected mixed serializeAndRestoreJob(mixed $job)

Сериализовать и десериализовать задачу для имитации процесса очереди.

Параметры

mixed $job

Значение результата

mixed

string getConnectionName()

Получить имя подключения для очереди.

Значение результата

string

$this setConnectionName(string $name)

Установить имя подключения для очереди.

Параметры

string $name

Значение результата

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Testing/Fakes/QueueFake.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API