Spec-Zone.ru › Laravel 9

QueueFake

класс QueueFake расширяет QueueManager и реализует Queue (Просмотреть исходный код)

Трейты

ReflectsClosures

Свойства

protected Application $app

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

из QueueManager
protected массив $connections

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

из QueueManager
protected массив $connectors

Массив разрешенных соединителей очереди.

из QueueManager
protected Queue $queue

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

protected Collection $jobsToFake

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

protected Collection $jobsToBeQueued

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

protected массив $jobs

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

Методы

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

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

void before(mixed $callback)

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

from QueueManager
void after(mixed $callback)

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

from QueueManager
void exceptionOccurred(mixed $callback)

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

from QueueManager
void looping(mixed $callback)

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

from QueueManager
void failing(mixed $callback)

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

from QueueManager
void stopping(mixed $callback)

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

from QueueManager
bool connected(string|null $name = null)

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

from QueueManager
Queue connection(mixed $value = null)

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

Queue resolve(string $name)

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

from QueueManager
ConnectorInterface getConnector(string $driver)

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

from QueueManager
void extend(string $driver, Closure $resolver)

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

from QueueManager
void addConnector(string $driver, Closure $resolver)

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

from QueueManager
array|null getConfig(string $name)

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

from QueueManager
string getDefaultDriver()

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

from QueueManager
void setDefaultDriver(string $name)

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

from QueueManager
string getName(string|null $connection = null)

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

from QueueManager
Application getApplication()

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

from QueueManager
$this setApplication(Application $app)

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

from QueueManager
mixed __call(string $method, array $parameters)

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

string firstClosureParameterType(Closure $closure)

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

from ReflectsClosures
array firstClosureParameterTypes(Closure $closure)

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

from ReflectsClosures
array closureParameterTypes(Closure $closure)

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

from 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)

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

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

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

bool isChainOfObjects(array $chain)

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

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

Определить, был ли отправлен job, основываясь на callback-функции проверки.

void assertNothingPushed()

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

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

Получить все job, соответствующие callback-функции проверки.

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 = [])

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

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()

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

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

Queue connection(mixed $value = null)

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

Parameters

mixed $value

Return Value

Queue

protected Queue resolve(string $name)

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

Parameters

string $name

Return Value

Queue

Exceptions

InvalidArgumentException
END_OF_DOCUMENT_MARKER

protected ConnectorInterface getConnector(string $driver)

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

Параметры

string $driver

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

ConnectorInterface

Исключения

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

Application getApplication()

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

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

Application

$this setApplication(Application $app)

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

Параметры

Application $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)

Проверить, был ли отправлен в очередь job, основываясь на обратном вызове truth-test.

Параметры

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

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

void

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

Проверить, был ли отправлен job с цепочкой зависимых задач, основываясь на обратном вызове truth-test.

Параметры

string $job
array $expectedChain
callable|null $callback

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

void

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

Проверить, был ли отправлен job с пустой цепочкой, основываясь на обратном вызове truth-test.

Параметры

string $job
callable|null $callback

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

void

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

Проверить, был ли отправлен job с цепочкой зависимых задач, основываясь на обратном вызове truth-test.

Параметры

string $job
array $expectedChain
callable|null $callback

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

void

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

Проверить, был ли отправлен job с цепочкой зависимых задач, основываясь на обратном вызове truth-test.

Параметры

string $job
array $expectedChain
callable|null $callback

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

void

protected bool isChainOfObjects(array $chain)

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

Параметры

array $chain

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

bool

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

Определить, был ли job отправлен в очередь, основываясь на обратном вызове truth-test.

Параметры

string|Closure $job
callable|null $callback

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

void

void assertNothingPushed()

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

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

void

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

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

Параметры

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

Задача|null pop(string|null $queue = null)

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

Параметры

string|null $queue

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

Задача|null

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

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

Параметры

array $jobs
mixed $data
string|null $queue

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

mixed

array pushedJobs()

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

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

array

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/9.x/Illuminate/Support/Testing/Fakes/QueueFake.html

Spec-Zone.ru

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