• 홈
• Crunz
• Event

PHP 클래스 Crunz\Event

파일 보기 프로젝트 열기: lavary/crunz 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$description	string	The human readable description of the event.
$output	string	The location that output should be sent to.
$outputStream	string	Event generated output
$preventOverlapping	boolean	Indicates if the command should not overlap itself.
$shouldAppendOutput	boolean	Indicates whether output should be appended.

보호된 프로퍼티들

프로퍼티	타입	설명
$afterCallbacks	array	The array of callbacks to be run after the event is finished.
$beforeCallbacks	array	The array of callbacks to be run before the event is started.
$command	string	The command string.
$cwd	string	Current working directory
$expression	string	The cron expression representing the event's frequency.
$fieldsPosition	array	Position of cron fields
$filters	array	The array of filter callbacks.
$id	string	The event's unique identifier
$process	Symfony\Component\Process\Process	Process that runs the event
$rejects	array	The array of reject callbacks.
$timezone	DateTimeZone | string	The timezone the date should be evaluated on.
$user	string	The user the command should run as.

공개 메소드들

메소드	설명
__call ( string $methodName, array $params )	Handling dynamic frequency methods
__construct ( $id, string $command ) : void	Create a new event instance.
after ( Closure $callback )	Register a callback to be called after the operation.
afterCallbacks ( ) : array	Return all registered after callbacks
appendOutputTo ( string $location )	Append the output of the command to a given location.
at ( string $time )	Schedule the command at a given time.
before ( Closure $callback )	Register a callback to be called before the operation.
beforeCallbacks ( ) : array	Return all registered before callbacks
between ( $from, $to )	Set Working period
buildCommand ( ) : string	Build the comand string.
cron ( string $expression )	The Cron expression representing the event's frequency.
daily ( )	Schedule the event to run daily.
dailyAt ( string $time )	Schedule the event to run daily at a given time (10:00, 19:30, etc).
dayOfMonth ( mixed $value )	Set hour for the cron job
dayOfWeek ( mixed $value )	Set hour for the cron job
days ( mixed $days )	Set the days of the week the command should run on.
description ( string $description )	Set the human-friendly description of the event.
every ( string $unit = null, string $value = null )	Another way to the frequency of the cron job
filtersPass ( ) : boolean	Determine if the filters pass for the event.
fridays ( )	Schedule the event to run only on Fridays.
from ( string $datetime )	Check if event should be on
getCommand ( ) : string	Return the event's command
getCommandForDisplay ( ) : string	Get the command for display
getExpression ( ) : string	Get the Cron expression for the event.
getId ( ) : string	Return the event's command
getOutputStream ( ) : string	Return event's full output
getProcess ( ) : Process	Return the event's process
getSummaryForDisplay ( ) : string	Get the summary of the event for display.
getWorkingDirectory ( ) : string	Return the current working directory
hour ( mixed $value )	Set hour for the cron job
hourly ( )	Schedule the event to run hourly.
in ( string $directory )	Change the current working directory.
isClosure ( ) : boolean	Determine whether the passed value is a closure ot not.
isDue ( ) : boolean	Determine if the given event should run based on the Cron expression.
isLocked ( ) : boolean	Check if another instance of the event is still running
lastPid ( ) : integer	Get the last process Id of the event
lockFile ( ) : string	Get the lock file path for the task
minute ( mixed $value )	Set minute for the cron job
mondays ( )	Schedule the event to run only on Mondays.
month ( mixed $value )	Set hour for the cron job
monthly ( )	Schedule the event to run monthly.
name ( string $description )	Set the human-friendly description of the event.
nullOutput ( ) : boolean	Determine if the event's output is sent to null.
on ( string $date )	Schedule the event to run on a certain date
pingBefore ( string $url )	Register a callback to ping a given URL before the job runs.
preventOverlapping ( )	Do not allow the event to overlap each other.
quarterly ( )	Schedule the event to run quarterly.
saturdays ( )	Schedule the event to run only on Saturdays.
sendOutputTo ( string $location, boolean $append = false )	Send the output of the command to a given location.
setCommand ( string $command )	Set the event's command
setProcess ( Process $process = null )	Set the event's process
skip ( Closure $callback )	Register a callback to further filter the schedule.
start ( ) : integer	Start the event execution
sundays ( )	Schedule the event to run only on Sundays.
then ( Closure $callback )	Register a callback to be called after the operation.
thenPing ( string $url )	Register a callback to ping a given URL after the job runs.
thursdays ( )	Schedule the event to run only on Thursdays.
timezone ( DateTimeZone | string $timezone )	Set the timezone the date should be evaluated on.
to ( string $datetime )	Check if event should be off
tuesdays ( )	Schedule the event to run only on Tuesdays.
twiceDaily ( integer $first = 1, integer $second = 13 )	Schedule the event to run twice daily.
user ( string $user )	Set which user the command should run as.
wednesdays ( )	Schedule the event to run only on Wednesdays.
weekdays ( )	Schedule the event to run only on weekdays.
weekly ( )	Schedule the event to run weekly.
weeklyOn ( integer $day, string $time = '0:0' )	Schedule the event to run weekly on a given day and time.
when ( Closure $callback )	Register a callback to further filter the schedule.
yearly ( )	Schedule the event to run yearly.

보호된 메소드들

메소드	설명
applyMask ( string $unit ) : string	Mask a cron expression
expressionPasses ( ) : boolean	Determine if the Cron expression passes.
getDefaultOutput ( ) : string	Get the default output depending on the OS.
lock ( ) : string	Lock the event
notYet ( $datetime ) : boolean	Check if time hasn't arrived
past ( $datetime ) : boolean	Check if the time has passed
serializeClosure ( string $closure ) : string	Convert closure to an executable command
spliceIntoPosition ( integer $position, string $value )	Splice the given value into the given position of the expression.
sudo ( string $user ) : string	Add sudo to the command

메소드 상세

프로퍼티 상세