W3cubDocs

/Laravel 5.3

CallbackEvent

class CallbackEvent extends Event (View source)

Properties

string $command The command string. from Event
string $expression The cron expression representing the event's frequency. from Event
DateTimeZone|string $timezone The timezone the date should be evaluated on. from Event
string $user The user the command should run as. from Event
array $environments The list of environments the command should run under. from Event
bool $evenInMaintenanceMode Indicates if the command should run in maintenance mode. from Event
bool $withoutOverlapping Indicates if the command should not overlap itself. from Event
bool $runInBackground Indicates if the command should run in background. from Event
string $output The location that output should be sent to. from Event
string $description The human readable description of the event. from Event

Methods

void __construct(string $callback, array $parameters = array())

Create a new event instance.
void run(Container $container)

Run the given event.
string buildCommand()

Build the command string.

 from Event
bool isDue(Application $app)

Determine if the given event should run based on the Cron expression.

 from Event
bool filtersPass(Application $app)

Determine if the filters pass for the event.

 from Event
bool runsInEnvironment(string $environment)

Determine if the event runs in the given environment.

 from Event
bool runsInMaintenanceMode()

Determine if the event runs in maintenance mode.

 from Event
$this cron(string $expression)

The Cron expression representing the event's frequency.

 from Event
$this hourly()

Schedule the event to run hourly.

 from Event
$this daily()

Schedule the event to run daily.

 from Event
$this at(string $time)

Schedule the command at a given time.

 from Event
$this dailyAt(string $time)

Schedule the event to run daily at a given time (10:00, 19:30, etc).

 from Event
$this twiceDaily(int $first = 1, int $second = 13)

Schedule the event to run twice daily.

 from Event
$this weekdays()

Schedule the event to run only on weekdays.

 from Event
$this mondays()

Schedule the event to run only on Mondays.

 from Event
$this tuesdays()

Schedule the event to run only on Tuesdays.

 from Event
$this wednesdays()

Schedule the event to run only on Wednesdays.

 from Event
$this thursdays()

Schedule the event to run only on Thursdays.

 from Event
$this fridays()

Schedule the event to run only on Fridays.

 from Event
$this saturdays()

Schedule the event to run only on Saturdays.

 from Event
$this sundays()

Schedule the event to run only on Sundays.

 from Event
$this weekly()

Schedule the event to run weekly.

 from Event
$this weeklyOn(int $day, string $time = '0:0')

Schedule the event to run weekly on a given day and time.

 from Event
$this monthly()

Schedule the event to run monthly.

 from Event
$this monthlyOn(int $day = 1, string $time = '0:0')

Schedule the event to run monthly on a given day and time.

 from Event
$this quarterly()

Schedule the event to run quarterly.

 from Event
$this yearly()

Schedule the event to run yearly.

 from Event
$this everyMinute()

Schedule the event to run every minute.

 from Event
$this everyFiveMinutes()

Schedule the event to run every five minutes.

 from Event
$this everyTenMinutes()

Schedule the event to run every ten minutes.

 from Event
$this everyThirtyMinutes()

Schedule the event to run every thirty minutes.

 from Event
$this days(array|mixed $days)

Set the days of the week the command should run on.

 from Event
$this runInBackground()

State that the command should run in background.

 from Event
$this timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

 from Event
$this user(string $user)

Set which user the command should run as.

 from Event
$this environments(array|mixed $environments)

Limit the environments the command should run in.

 from Event
$this evenInMaintenanceMode()

State that the command should run even in maintenance mode.

 from Event
$this withoutOverlapping()

Do not allow the event to overlap each other.
$this when(Closure $callback)

Register a callback to further filter the schedule.

 from Event
$this skip(Closure $callback)

Register a callback to further filter the schedule.

 from Event
$this sendOutputTo(string $location, bool $append = false)

Send the output of the command to a given location.

 from Event
$this appendOutputTo(string $location)

Append the output of the command to a given location.

 from Event
$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)

E-mail the results of the scheduled operation.

 from Event
$this emailWrittenOutputTo(array|mixed $addresses)

E-mail the results of the scheduled operation if it produces output.

 from Event
$this pingBefore(string $url)

Register a callback to ping a given URL before the job runs.

 from Event
$this before(Closure $callback)

Register a callback to be called before the operation.

 from Event
$this thenPing(string $url)

Register a callback to ping a given URL after the job runs.

 from Event
$this after(Closure $callback)

Register a callback to be called after the operation.

 from Event
$this then(Closure $callback)

Register a callback to be called after the operation.

 from Event
$this name(string $description)

Set the human-friendly description of the event.

 from Event
$this description(string $description)

Set the human-friendly description of the event.

 from Event
string getSummaryForDisplay()

Get the summary of the event for display.
string getExpression()

Get the Cron expression for the event.

 from Event

Details

void __construct(string $callback, array $parameters = array())

Create a new event instance.

Parameters

string $callback
array $parameters

Return Value

void

Exceptions

InvalidArgumentException

void run(Container $container)

Run the given event.

Parameters

Container $container

Return Value

void

Exceptions

Exception

string buildCommand()

Build the command string.

Return Value

string

bool isDue(Application $app)

Determine if the given event should run based on the Cron expression.

Parameters

Application $app

Return Value

bool

bool filtersPass(Application $app)

Determine if the filters pass for the event.

Parameters

Application $app

Return Value

bool

bool runsInEnvironment(string $environment)

Determine if the event runs in the given environment.

Parameters

string $environment

Return Value

bool

bool runsInMaintenanceMode()

Determine if the event runs in maintenance mode.

Return Value

bool

$this cron(string $expression)

The Cron expression representing the event's frequency.

Parameters

string $expression

Return Value

$this

$this hourly()

Schedule the event to run hourly.

Return Value

$this

$this daily()

Schedule the event to run daily.

Return Value

$this

$this at(string $time)

Schedule the command at a given time.

Parameters

string $time

Return Value

$this

$this dailyAt(string $time)

Schedule the event to run daily at a given time (10:00, 19:30, etc).

Parameters

string $time

Return Value

$this

$this twiceDaily(int $first = 1, int $second = 13)

Schedule the event to run twice daily.

Parameters

int $first
int $second

Return Value

$this

$this weekdays()

Schedule the event to run only on weekdays.

Return Value

$this

$this mondays()

Schedule the event to run only on Mondays.

Return Value

$this

$this tuesdays()

Schedule the event to run only on Tuesdays.

Return Value

$this

$this wednesdays()

Schedule the event to run only on Wednesdays.

Return Value

$this

$this thursdays()

Schedule the event to run only on Thursdays.

Return Value

$this

$this fridays()

Schedule the event to run only on Fridays.

Return Value

$this

$this saturdays()

Schedule the event to run only on Saturdays.

Return Value

$this

$this sundays()

Schedule the event to run only on Sundays.

Return Value

$this

$this weekly()

Schedule the event to run weekly.

Return Value

$this

$this weeklyOn(int $day, string $time = '0:0')

Schedule the event to run weekly on a given day and time.

Parameters

int $day
string $time

Return Value

$this

$this monthly()

Schedule the event to run monthly.

Return Value

$this

$this monthlyOn(int $day = 1, string $time = '0:0')

Schedule the event to run monthly on a given day and time.

Parameters

int $day
string $time

Return Value

$this

$this quarterly()

Schedule the event to run quarterly.

Return Value

$this

$this yearly()

Schedule the event to run yearly.

Return Value

$this

$this everyMinute()

Schedule the event to run every minute.

Return Value

$this

$this everyFiveMinutes()

Schedule the event to run every five minutes.

Return Value

$this

$this everyTenMinutes()

Schedule the event to run every ten minutes.

Return Value

$this

$this everyThirtyMinutes()

Schedule the event to run every thirty minutes.

Return Value

$this

$this days(array|mixed $days)

Set the days of the week the command should run on.

Parameters

array|mixed $days

Return Value

$this

$this runInBackground()

State that the command should run in background.

Return Value

$this

$this timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

Parameters

DateTimeZone|string $timezone

Return Value

$this

$this user(string $user)

Set which user the command should run as.

Parameters

string $user

Return Value

$this

$this environments(array|mixed $environments)

Limit the environments the command should run in.

Parameters

array|mixed $environments

Return Value

$this

$this evenInMaintenanceMode()

State that the command should run even in maintenance mode.

Return Value

$this

$this withoutOverlapping()

Do not allow the event to overlap each other.

Return Value

$this

Exceptions

LogicException

$this when(Closure $callback)

Register a callback to further filter the schedule.

Parameters

Closure $callback

Return Value

$this

$this skip(Closure $callback)

Register a callback to further filter the schedule.

Parameters

Closure $callback

Return Value

$this

$this sendOutputTo(string $location, bool $append = false)

Send the output of the command to a given location.

Parameters

string $location
bool $append

Return Value

$this

$this appendOutputTo(string $location)

Append the output of the command to a given location.

Parameters

string $location

Return Value

$this

$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)

E-mail the results of the scheduled operation.

Parameters

array|mixed $addresses
bool $onlyIfOutputExists

Return Value

$this

Exceptions

LogicException

$this emailWrittenOutputTo(array|mixed $addresses)

E-mail the results of the scheduled operation if it produces output.

Parameters

array|mixed $addresses

Return Value

$this

Exceptions

LogicException

$this pingBefore(string $url)

Register a callback to ping a given URL before the job runs.

Parameters

string $url

Return Value

$this

$this before(Closure $callback)

Register a callback to be called before the operation.

Parameters

Closure $callback

Return Value

$this

$this thenPing(string $url)

Register a callback to ping a given URL after the job runs.

Parameters

string $url

Return Value

$this

$this after(Closure $callback)

Register a callback to be called after the operation.

Parameters

Closure $callback

Return Value

$this

$this then(Closure $callback)

Register a callback to be called after the operation.

Parameters

Closure $callback

Return Value

$this

$this name(string $description)

Set the human-friendly description of the event.

Parameters

string $description

Return Value

$this

$this description(string $description)

Set the human-friendly description of the event.

Parameters

string $description

Return Value

$this

string getSummaryForDisplay()

Get the summary of the event for display.

Return Value

string

string getExpression()

Get the Cron expression for the event.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Console/Scheduling/CallbackEvent.html