74 lines
2.2 KiB
YAML
74 lines
2.2 KiB
YAML
|
name: AsPeriodicTask
|
||
|
|
class_comment: null
|
||
|
|
dependencies: []
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: __construct
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: frequency
|
||
|
|
- name: from
|
||
|
|
default: 'null'
|
||
|
|
- name: until
|
||
|
|
default: 'null'
|
||
|
|
- name: jitter
|
||
|
|
default: 'null'
|
||
|
|
- name: arguments
|
||
|
|
default: 'null'
|
||
|
|
- name: schedule
|
||
|
|
default: '''default'''
|
||
|
|
- name: method
|
||
|
|
default: 'null'
|
||
|
|
- name: transports
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * A marker to call a service method from scheduler.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @author valtzu <valtzu@gmail.com>
|
||
|
|
|
||
|
|
# */
|
||
|
|
|
||
|
|
# #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
|
||
|
|
|
||
|
|
# class AsPeriodicTask
|
||
|
|
|
||
|
|
# {
|
||
|
|
|
||
|
|
# /**
|
||
|
|
|
||
|
|
# * @param string|int $frequency A string (i.e. "every
|
||
|
|
hour") or an integer (the number of seconds) representing the frequency of the
|
||
|
|
task
|
||
|
|
|
||
|
|
# * @param string|null $from A string representing
|
||
|
|
the start time of the periodic task (i.e. "08:00:00")
|
||
|
|
|
||
|
|
# * @param string|null $until A string representing
|
||
|
|
the end time of the periodic task (i.e. "20:00:00")
|
||
|
|
|
||
|
|
# * @param int|null $jitter The cron jitter, in
|
||
|
|
seconds; for example, if set to 60, the cron
|
||
|
|
|
||
|
|
# * will randomly wait
|
||
|
|
for a number of seconds between 0 and 60 before
|
||
|
|
|
||
|
|
# * executing which allows
|
||
|
|
to avoid load spikes that can happen when many tasks
|
||
|
|
|
||
|
|
# * run at the same time
|
||
|
|
|
||
|
|
# * @param array<array-key, mixed>|string|null $arguments The arguments to pass
|
||
|
|
to the cron task
|
||
|
|
|
||
|
|
# * @param string $schedule The name of the schedule
|
||
|
|
responsible for triggering the task
|
||
|
|
|
||
|
|
# * @param string|null $method The method to run as
|
||
|
|
the task when the attribute target is a class
|
||
|
|
|
||
|
|
# * @param string[]|string|null $transports One or many transports
|
||
|
|
through which the message scheduling the task will go'
|
||
|
|
traits: []
|
||
|
|
interfaces: []
|