spqr/vendor/illuminate/support/Facades/Queue.php

92 lines
4.1 KiB
PHP
Raw Normal View History

2024-11-05 12:10:06 +08:00
<?php
namespace Illuminate\Support\Facades;
use Illuminate\Queue\Worker;
use Illuminate\Support\Testing\Fakes\QueueFake;
/**
* @method static void before(mixed $callback)
* @method static void after(mixed $callback)
* @method static void exceptionOccurred(mixed $callback)
* @method static void looping(mixed $callback)
* @method static void failing(mixed $callback)
* @method static void stopping(mixed $callback)
* @method static bool connected(string|null $name = null)
* @method static \Illuminate\Contracts\Queue\Queue connection(string|null $name = null)
* @method static void extend(string $driver, \Closure $resolver)
* @method static void addConnector(string $driver, \Closure $resolver)
* @method static string getDefaultDriver()
* @method static void setDefaultDriver(string $name)
* @method static string getName(string|null $connection = null)
* @method static \Illuminate\Contracts\Foundation\Application getApplication()
* @method static \Illuminate\Queue\QueueManager setApplication(\Illuminate\Contracts\Foundation\Application $app)
* @method static int size(string|null $queue = null)
* @method static mixed push(string|object $job, mixed $data = '', string|null $queue = null)
* @method static mixed pushOn(string $queue, string|object $job, mixed $data = '')
* @method static mixed pushRaw(string $payload, string|null $queue = null, array $options = [])
* @method static mixed later(\DateTimeInterface|\DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
* @method static mixed laterOn(string $queue, \DateTimeInterface|\DateInterval|int $delay, string|object $job, mixed $data = '')
* @method static mixed bulk(array $jobs, mixed $data = '', string|null $queue = null)
* @method static \Illuminate\Contracts\Queue\Job|null pop(string|null $queue = null)
* @method static string getConnectionName()
* @method static \Illuminate\Contracts\Queue\Queue setConnectionName(string $name)
* @method static mixed getJobBackoff(mixed $job)
* @method static mixed getJobExpiration(mixed $job)
* @method static void createPayloadUsing(callable|null $callback)
* @method static \Illuminate\Container\Container getContainer()
* @method static void setContainer(\Illuminate\Container\Container $container)
* @method static \Illuminate\Support\Testing\Fakes\QueueFake except(array|string $jobsToBeQueued)
* @method static void assertPushed(string|\Closure $job, callable|int|null $callback = null)
* @method static void assertPushedOn(string $queue, string|\Closure $job, callable|null $callback = null)
* @method static void assertPushedWithChain(string $job, array $expectedChain = [], callable|null $callback = null)
* @method static void assertPushedWithoutChain(string $job, callable|null $callback = null)
* @method static void assertNotPushed(string|\Closure $job, callable|null $callback = null)
* @method static void assertNothingPushed()
* @method static \Illuminate\Support\Collection pushed(string $job, callable|null $callback = null)
* @method static bool hasPushed(string $job)
* @method static bool shouldFakeJob(object $job)
* @method static array pushedJobs()
*
* @see \Illuminate\Queue\QueueManager
* @see \Illuminate\Queue\Queue
* @see \Illuminate\Support\Testing\Fakes\QueueFake
*/
class Queue extends Facade
{
/**
* Register a callback to be executed to pick jobs.
*
* @param string $workerName
* @param callable $callback
* @return void
*/
public static function popUsing($workerName, $callback)
{
return Worker::popUsing($workerName, $callback);
}
/**
* Replace the bound instance with a fake.
*
* @param array|string $jobsToFake
* @return \Illuminate\Support\Testing\Fakes\QueueFake
*/
public static function fake($jobsToFake = [])
{
static::swap($fake = new QueueFake(static::getFacadeApplication(), $jobsToFake, static::getFacadeRoot()));
return $fake;
}
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
return 'queue';
}
}