PHP Class omnilight\scheduling\Schedule

Inheritance: extends yii\base\Component
Afficher le fichier Open project: omnilight/yii2-scheduling Class Usage Examples

Méthodes publiques

Свойство Type Description
$cliScriptName The name of cli script

Protected Properties

Свойство Type Description
$_events Event[] All of the events on the schedule.

Méthodes publiques

Méthode 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 méthode

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

command() public méthode

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

dueEvents() public méthode

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

exec() public méthode

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

getEvents() public méthode

public getEvents ( )

Property Details

$_events protected_oe property

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

$cliScriptName public_oe property

The name of cli script
public $cliScriptName