PHP Class omnilight\scheduling\Schedule

Inheritance: extends yii\base\Component
Datei anzeigen Open project: omnilight/yii2-scheduling Class Usage Examples

Public Properties

Property Type Description
$cliScriptName The name of cli script

Protected Properties

Property Type Description
$_events Event[] All of the events on the schedule.

Public Methods

Method Description
call ( string $callback, array $parameters = [] ) : Event Add a new callback event to the schedule.
command ( string $command ) : Event Add a new cli command event to the schedule.
dueEvents ( Application $app ) : Event[] Get all of the events on the schedule that are due.
exec ( string $command ) : Event Add a new command event to the schedule.
getEvents ( )

Method Details

call() public method

Add a new callback event to the schedule.
public call ( string $callback, array $parameters = [] ) : Event
$callback string
$parameters array
return Event

command() public method

Add a new cli command event to the schedule.
public command ( string $command ) : Event
$command string
return Event

dueEvents() public method

Get all of the events on the schedule that are due.
public dueEvents ( Application $app ) : Event[]
$app yii\base\Application
return Event[]

exec() public method

Add a new command event to the schedule.
public exec ( string $command ) : Event
$command string
return Event

getEvents() public method

public getEvents ( )

Property Details

$_events protected_oe property

All of the events on the schedule.
protected Event[],omnilight\scheduling $_events
return Event[]

$cliScriptName public_oe property

The name of cli script
public $cliScriptName