api/symfony/Component/Scheduler/Scheduler.yaml

73 lines
1.9 KiB
YAML
Raw Permalink Normal View History

2024-09-26 09:03:21 +00:00
name: Scheduler
class_comment: null
dependencies:
- name: EventDispatcherInterface
type: class
source: Psr\EventDispatcher\EventDispatcherInterface
- name: Clock
type: class
source: Symfony\Component\Clock\Clock
- name: ClockInterface
type: class
source: Symfony\Component\Clock\ClockInterface
- name: FailureEvent
type: class
source: Symfony\Component\Scheduler\Event\FailureEvent
- name: PostRunEvent
type: class
source: Symfony\Component\Scheduler\Event\PostRunEvent
- name: PreRunEvent
type: class
source: Symfony\Component\Scheduler\Event\PreRunEvent
- name: MessageGenerator
type: class
source: Symfony\Component\Scheduler\Generator\MessageGenerator
properties: []
methods:
- name: __construct
visibility: public
parameters:
- name: handlers
- name: schedules
- name: clock
default: new Clock(
comment: "# * @var array<MessageGenerator>\n# */\n# private array $generators =\
\ [];\n# private int $index = 0;\n# private bool $shouldStop = false;\n# \n# /**\n\
# * @param iterable<Schedule> $schedules"
- name: addSchedule
visibility: public
parameters:
- name: schedule
comment: null
- name: addMessageGenerator
visibility: public
parameters:
- name: generator
comment: null
- name: run
visibility: public
parameters:
- name: options
default: '[]'
comment: '# * Schedules messages.
# *
# * Valid options are:
# * * sleep (default: 1000000): Time in microseconds to sleep after no messages
are found'
- name: stop
visibility: public
parameters: []
comment: null
traits:
- Psr\EventDispatcher\EventDispatcherInterface
- Symfony\Component\Clock\Clock
- Symfony\Component\Clock\ClockInterface
- Symfony\Component\Scheduler\Event\FailureEvent
- Symfony\Component\Scheduler\Event\PostRunEvent
- Symfony\Component\Scheduler\Event\PreRunEvent
- Symfony\Component\Scheduler\Generator\MessageGenerator
interfaces: []