291 lines
8.5 KiB
YAML
291 lines
8.5 KiB
YAML
|
name: Queue
|
||
|
|
class_comment: '# * @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 getJobTries(mixed $job)
|
||
|
|
|
||
|
|
# * @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 assertClosurePushed(callable|int|null $callback = null)
|
||
|
|
|
||
|
|
# * @method static void assertClosureNotPushed(callable|null $callback = null)
|
||
|
|
|
||
|
|
# * @method static void assertNotPushed(string|\Closure $job, callable|null $callback
|
||
|
|
= null)
|
||
|
|
|
||
|
|
# * @method static void assertCount(int $expectedCount)
|
||
|
|
|
||
|
|
# * @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()
|
||
|
|
|
||
|
|
# * @method static \Illuminate\Support\Testing\Fakes\QueueFake serializeAndRestore(bool
|
||
|
|
$serializeAndRestore = true)
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @see \Illuminate\Queue\QueueManager
|
||
|
|
|
||
|
|
# * @see \Illuminate\Queue\Queue
|
||
|
|
|
||
|
|
# * @see \Illuminate\Support\Testing\Fakes\QueueFake'
|
||
|
|
dependencies:
|
||
|
|
- name: Worker
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Queue\Worker
|
||
|
|
- name: QueueFake
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Support\Testing\Fakes\QueueFake
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: popUsing
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: workerName
|
||
|
|
- name: callback
|
||
|
|
comment: '# * @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 getJobTries(mixed $job)
|
||
|
|
|
||
|
|
# * @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 assertClosurePushed(callable|int|null $callback = null)
|
||
|
|
|
||
|
|
# * @method static void assertClosureNotPushed(callable|null $callback = null)
|
||
|
|
|
||
|
|
# * @method static void assertNotPushed(string|\Closure $job, callable|null $callback
|
||
|
|
= null)
|
||
|
|
|
||
|
|
# * @method static void assertCount(int $expectedCount)
|
||
|
|
|
||
|
|
# * @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()
|
||
|
|
|
||
|
|
# * @method static \Illuminate\Support\Testing\Fakes\QueueFake serializeAndRestore(bool
|
||
|
|
$serializeAndRestore = true)
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @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'
|
||
|
|
- name: fake
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: jobsToFake
|
||
|
|
default: '[]'
|
||
|
|
comment: '# * Replace the bound instance with a fake.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param array|string $jobsToFake
|
||
|
|
|
||
|
|
# * @return \Illuminate\Support\Testing\Fakes\QueueFake'
|
||
|
|
- name: getFacadeAccessor
|
||
|
|
visibility: protected
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the registered name of the component.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
traits:
|
||
|
|
- Illuminate\Queue\Worker
|
||
|
|
- Illuminate\Support\Testing\Fakes\QueueFake
|
||
|
|
interfaces: []
|