HighSpeaker/vendor/illuminate/support/Facades/Bus.php
2024-01-31 22:15:08 +08:00

92 lines
4.3 KiB
PHP

<?php
namespace Illuminate\Support\Facades;
use Illuminate\Bus\BatchRepository;
use Illuminate\Contracts\Bus\Dispatcher as BusDispatcherContract;
use Illuminate\Foundation\Bus\PendingChain;
use Illuminate\Support\Testing\Fakes\BusFake;
/**
* @method static mixed dispatch(mixed $command)
* @method static mixed dispatchSync(mixed $command, mixed $handler = null)
* @method static mixed dispatchNow(mixed $command, mixed $handler = null)
* @method static \Illuminate\Bus\Batch|null findBatch(string $batchId)
* @method static \Illuminate\Bus\PendingBatch batch(\Illuminate\Support\Collection|array|mixed $jobs)
* @method static \Illuminate\Foundation\Bus\PendingChain chain(\Illuminate\Support\Collection|array $jobs)
* @method static bool hasCommandHandler(mixed $command)
* @method static bool|mixed getCommandHandler(mixed $command)
* @method static mixed dispatchToQueue(mixed $command)
* @method static void dispatchAfterResponse(mixed $command, mixed $handler = null)
* @method static \Illuminate\Bus\Dispatcher pipeThrough(array $pipes)
* @method static \Illuminate\Bus\Dispatcher map(array $map)
* @method static void except(array|string $jobsToDispatch)
* @method static void assertDispatched(string|\Closure $command, callable|int|null $callback = null)
* @method static void assertDispatchedTimes(string|\Closure $command, int $times = 1)
* @method static void assertNotDispatched(string|\Closure $command, callable|null $callback = null)
* @method static void assertNothingDispatched()
* @method static void assertDispatchedSync(string|\Closure $command, callable|int|null $callback = null)
* @method static void assertDispatchedSyncTimes(string|\Closure $command, int $times = 1)
* @method static void assertNotDispatchedSync(string|\Closure $command, callable|null $callback = null)
* @method static void assertDispatchedAfterResponse(string|\Closure $command, callable|int|null $callback = null)
* @method static void assertDispatchedAfterResponseTimes(string|\Closure $command, int $times = 1)
* @method static void assertNotDispatchedAfterResponse(string|\Closure $command, callable|null $callback = null)
* @method static void assertChained(array $expectedChain)
* @method static void assertDispatchedWithoutChain(string|\Closure $command, callable|null $callback = null)
* @method static void assertBatched(callable $callback)
* @method static void assertBatchCount(int $count)
* @method static void assertNothingBatched()
* @method static \Illuminate\Support\Collection dispatched(string $command, callable|null $callback = null)
* @method static \Illuminate\Support\Collection dispatchedSync(string $command, callable|null $callback = null)
* @method static \Illuminate\Support\Collection dispatchedAfterResponse(string $command, callable|null $callback = null)
* @method static \Illuminate\Support\Collection batched(callable $callback)
* @method static bool hasDispatched(string $command)
* @method static bool hasDispatchedSync(string $command)
* @method static bool hasDispatchedAfterResponse(string $command)
* @method static \Illuminate\Bus\Batch dispatchFakeBatch(string $name = '')
* @method static \Illuminate\Bus\Batch recordPendingBatch(\Illuminate\Bus\PendingBatch $pendingBatch)
*
* @see \Illuminate\Bus\Dispatcher
* @see \Illuminate\Support\Testing\Fakes\BusFake
*/
class Bus extends Facade
{
/**
* Replace the bound instance with a fake.
*
* @param array|string $jobsToFake
* @param \Illuminate\Bus\BatchRepository|null $batchRepository
* @return \Illuminate\Support\Testing\Fakes\BusFake
*/
public static function fake($jobsToFake = [], BatchRepository $batchRepository = null)
{
static::swap($fake = new BusFake(static::getFacadeRoot(), $jobsToFake, $batchRepository));
return $fake;
}
/**
* Dispatch the given chain of jobs.
*
* @param array|mixed $jobs
* @return \Illuminate\Foundation\Bus\PendingDispatch
*/
public static function dispatchChain($jobs)
{
$jobs = is_array($jobs) ? $jobs : func_get_args();
return (new PendingChain(array_shift($jobs), $jobs))
->dispatch();
}
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
return BusDispatcherContract::class;
}
}