API Documentation
Back to top  

AbstractCronjobTask

Class AbstractCronjobTask

package

Default

Methods

AbstractCronjob constructor.

__construct(\StringType $schedule, \IntType $sortOrder, \AbstractCronjobLogger $logger, \AbstractCronjobDependencies $dependencies)

Arguments

$schedule

\StringType

Cronjob schedule, can be a cron expression string.

$sortOrder

\IntType

Sort order of cronjob execution.

$logger

\AbstractCronjobLogger

Logger instance for the cronjob callback.

$dependencies

\AbstractCronjobDependencies

Dependencies of cronjob's service.

Named constructor of AbstractCronjob

create(string $schedule, integer $sortOrder) : \AbstractCronjobTask
static

Arguments

$schedule

string

Cronjob schedule, can be a cron expression string.

$sortOrder

integer

Sort order of cronjob execution.

Response

\AbstractCronjobTask

New instance.

Returns the cronjob callback.

getCallback(float $cronjobStartAsMicrotime) : \Closure
abstract

Arguments

$cronjobStartAsMicrotime

float

Response

\Closure

Returns the cronjob name.

getName() : string

Response

string

Returns the cronjob schedule.

getSchedule() : string

Response

string

Returns the cronjob sort order.

getSortOrder() : integer

Response

integer

Runs the cronjob callback.

run( $cronjobStartAsMicrotime) : mixed

Arguments

$cronjobStartAsMicrotime

Response

mixed

Properties

name

name : string
var

Type(s)

string

schedule

schedule : string
var

Type(s)

string

sortOrder

sortOrder : integer
var

Type(s)

integer

logger

logger : \AbstractCronjobLogger
var

Type(s)

\AbstractCronjobLogger

dependencies

dependencies : \AbstractCronjobDependencies
var

Type(s)

\AbstractCronjobDependencies