class Schedule (View source)

Traits

Properties

protected integer $id from BaseEntityTrait
protected string $name
protected Request $request from RequestEntityTrait
protected string $description
protected string $minute
protected string $hour
protected string $day
protected string $month
protected string $weekday
protected string $year
protected boolean $enabled
protected datetime $firstrun
protected datetime $lastrun

Methods

integer
getId()

Get queue item's id

Schedule
setId(string $id)

Set queue item's id

string
getName()

Get queue item's name

Schedule
setName(string $name)

Set queue item's name

array
toArray()

Returns the properties of this object as an array for ease of use

getRequest()

Get desired process niceness

setRequest(Request $request)

Set desired process niceness

string
getDescription()

Get a brief job description

setDescription(string $description)

Set brief job description

string
getExpression()

Get cron expression of this schedule

setExpression(CronExpression $expression)

set cron expression for this schedule

bool
getEnabled()

True if job is currently enabled

setEnabled($enabled)

Set enable/disable status

getFirstrun()

Get the first-run-date of job

setFirstrun(DateTime $datetime)

Set the first-run-date of job

getLastrun()

Get the first-run-date of job

setLastrun(DateTime $datetime)

Set the first-run-date of job

shouldRunJob(DateTime $time)

No description

getNextPlannedRun(DateTime $time)

No description

merge(Schedule $schedule)

No description

buildExpression()

No description

Details

integer getId()

Get queue item's id

Return Value

integer

Schedule setId(string $id)

Set queue item's id

Parameters

string $id

Return Value

Schedule

string getName()

Get queue item's name

Return Value

string

Schedule setName(string $name)

Set queue item's name

Parameters

string $name

Return Value

Schedule

array toArray()

Returns the properties of this object as an array for ease of use

Return Value

array

Request getRequest()

Get desired process niceness

Return Value

Request

RequestEntityTrait setRequest(Request $request)

Set desired process niceness

Parameters

Request $request

Return Value

RequestEntityTrait

string getDescription()

Get a brief job description

Return Value

string

Schedule setDescription(string $description)

Set brief job description

Parameters

string $description

Return Value

Schedule

string getExpression()

Get cron expression of this schedule

Return Value

string

Schedule setExpression(CronExpression $expression)

set cron expression for this schedule

Parameters

CronExpression $expression A cron-compatible expression

Return Value

Schedule

bool getEnabled()

True if job is currently enabled

Return Value

bool

Schedule setEnabled($enabled)

Set enable/disable status

Parameters

$enabled

Return Value

Schedule

DateTime getFirstrun()

Get the first-run-date of job

Return Value

DateTime

Schedule setFirstrun(DateTime $datetime)

Set the first-run-date of job

Parameters

DateTime $datetime

Return Value

Schedule

DateTime getLastrun()

Get the first-run-date of job

Return Value

DateTime

Schedule setLastrun(DateTime $datetime)

Set the first-run-date of job

Parameters

DateTime $datetime

Return Value

Schedule

shouldRunJob(DateTime $time)

Parameters

DateTime $time

getNextPlannedRun(DateTime $time)

Parameters

DateTime $time

merge(Schedule $schedule)

Parameters

Schedule $schedule

protected buildExpression()