1. class
  2. Comodojo
  3. \
  4. Extender
  5. \
  6. Orm
  7. \
  8. Entities
  9. \
  10. Schedule

Schedule

class Schedule (View source)

Traits

BaseEntityTrait
RequestEntityTrait

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

from BaseEntityTrait
Schedule
setId(string $id)

Set queue item's id

from BaseEntityTrait
string
getName()

Get queue item's name

from BaseEntityTrait
Schedule
setName(string $name)

Set queue item's name

from BaseEntityTrait
array
toArray()

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

from BaseEntityTrait
Request
getRequest()

Get desired process niceness

from RequestEntityTrait
RequestEntityTrait
setRequest(Request $request)

Set desired process niceness

from RequestEntityTrait
string
getDescription()

Get a brief job description

Schedule
setDescription(string $description)

Set brief job description

string
getExpression()

Get cron expression of this schedule

Schedule
setExpression(CronExpression $expression)

set cron expression for this schedule

bool
getEnabled()

True if job is currently enabled

Schedule
setEnabled($enabled)

Set enable/disable status

DateTime
getFirstrun()

Get the first-run-date of job

Schedule
setFirstrun(DateTime $datetime)

Set the first-run-date of job

DateTime
getLastrun()

Get the first-run-date of job

Schedule
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

in BaseEntityTrait at line 42
integer getId()

Get queue item's id

Return Value

integer

in BaseEntityTrait at line 54
Schedule setId(string $id)

Set queue item's id

Parameters

string $id

Return Value

Schedule

in BaseEntityTrait at line 67
string getName()

Get queue item's name

Return Value

string

in BaseEntityTrait at line 79
Schedule setName(string $name)

Set queue item's name

Parameters

string $name

Return Value

Schedule

in BaseEntityTrait at line 92
array toArray()

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

Return Value

array

in RequestEntityTrait at line 35
Request getRequest()

Get desired process niceness

Return Value

Request

in RequestEntityTrait at line 47
RequestEntityTrait setRequest(Request $request)

Set desired process niceness

Parameters

Request $request

Return Value

RequestEntityTrait

at line 116
string getDescription()

Get a brief job description

Return Value

string

at line 128
Schedule setDescription(string $description)

Set brief job description

Parameters

string $description

Return Value

Schedule

at line 141
string getExpression()

Get cron expression of this schedule

Return Value

string

at line 153
Schedule setExpression(CronExpression $expression)

set cron expression for this schedule

Parameters

CronExpression $expression A cron-compatible expression

Return Value

Schedule

at line 171
bool getEnabled()

True if job is currently enabled

Return Value

bool

at line 183
Schedule setEnabled($enabled)

Set enable/disable status

Parameters

$enabled

Return Value

Schedule

at line 198
DateTime getFirstrun()

Get the first-run-date of job

Return Value

DateTime

at line 210
Schedule setFirstrun(DateTime $datetime)

Set the first-run-date of job

Parameters

DateTime $datetime

Return Value

Schedule

at line 223
DateTime getLastrun()

Get the first-run-date of job

Return Value

DateTime

at line 235
Schedule setLastrun(DateTime $datetime)

Set the first-run-date of job

Parameters

DateTime $datetime

Return Value

Schedule

at line 243
shouldRunJob(DateTime $time)

Parameters

DateTime $time

at line 256
getNextPlannedRun(DateTime $time)

Parameters

DateTime $time

at line 273
merge(Schedule $schedule)

Parameters

Schedule $schedule

at line 284
protected buildExpression()