Documentation

Cron
in package

Table of Contents

Constants

TYPE_DAY  = 'day'
TYPE_HOUR  = 'hour'
TYPE_MINUTE  = 'minute'
TYPE_MONTH  = 'month'
TYPE_UNDEFINED  = ''
TYPE_WEEK  = 'week'
TYPE_YEAR  = 'year'

Properties

$cron  : string
min hour dom month dow
$dom  : array<string|int, mixed>
$dow  : array<string|int, mixed>
0-7 : sunday, monday, ... saturday, sunday
$hours  : array<string|int, mixed>
$minutes  : array<string|int, mixed>
$months  : array<string|int, mixed>
$texts  : array<string|int, mixed>

Methods

__construct()  : mixed
getCron()  : string
getCronDaysOfMonth()  : string
getCronDaysOfWeek()  : string
getCronHours()  : string
getCronMinutes()  : string
getCronMonths()  : string
getDaysOfMonth()  : array<string|int, mixed>
getDaysOfWeek()  : array<string|int, mixed>
getHours()  : array<string|int, mixed>
getMinutes()  : array<string|int, mixed>
getMonths()  : array<string|int, mixed>
getText()  : string
getType()  : string
matchExact()  : mixed
matchWithMargin()  : mixed
setCron()  : $this
setDaysOfMonth()  : $this
setDaysOfWeek()  : $this
setHours()  : $this
setMinutes()  : $this
setMonths()  : $this
arrayToCron()  : string
cronToArray()  : array<string|int, mixed>
parseDate()  : DateTime

Constants

TYPE_DAY

public mixed TYPE_DAY = 'day'

TYPE_HOUR

public mixed TYPE_HOUR = 'hour'

TYPE_MINUTE

public mixed TYPE_MINUTE = 'minute'

TYPE_MONTH

public mixed TYPE_MONTH = 'month'

TYPE_UNDEFINED

public mixed TYPE_UNDEFINED = ''

TYPE_WEEK

public mixed TYPE_WEEK = 'week'

TYPE_YEAR

public mixed TYPE_YEAR = 'year'

Properties

$cron

min hour dom month dow

protected string $cron = ''

$dom

protected array<string|int, mixed> $dom = []

$dow

0-7 : sunday, monday, ... saturday, sunday

protected array<string|int, mixed> $dow = []

$hours

protected array<string|int, mixed> $hours = []

$minutes

protected array<string|int, mixed> $minutes = []

$months

protected array<string|int, mixed> $months = []

$texts

protected array<string|int, mixed> $texts = ['fr' => ['empty' => '-tout-', 'name_minute' => 'minute', 'name_hour' => 'heure', 'name_day' => 'jour', 'name_week' => 'semaine', 'name_month' => 'mois', 'name_year' => 'année', 'text_period' => 'Chaque %s', 'text_mins' => 'à %s minutes', 'text_time' => 'à %02s:%02s', 'text_dow' => 'le %s', 'text_month' => 'de %s', 'text_dom' => 'le %s', 'weekdays' => ['lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi', 'dimanche'], 'months' => ['janvier', 'février', 'mars', 'avril', 'mai', 'juin', 'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre']], 'en' => ['empty' => '-all-', 'name_minute' => 'minute', 'name_hour' => 'hour', 'name_day' => 'day', 'name_week' => 'week', 'name_month' => 'month', 'name_year' => 'year', 'text_period' => 'Every %s', 'text_mins' => 'at %s minutes past the hour', 'text_time' => 'at %02s:%02s', 'text_dow' => 'on %s', 'text_month' => 'of %s', 'text_dom' => 'on the %s', 'weekdays' => ['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'], 'months' => ['january', 'february', 'march', 'april', 'may', 'june', 'july', 'august', 'september', 'october', 'november', 'december']]]

Methods

__construct()

public __construct([string|null $cron = null ]) : mixed
Parameters
$cron : string|null = null

getCron()

public getCron() : string
Return values
string

getCronDaysOfMonth()

public getCronDaysOfMonth() : string
Return values
string

getCronDaysOfWeek()

public getCronDaysOfWeek() : string
Return values
string

getCronHours()

public getCronHours() : string
Return values
string

getCronMinutes()

public getCronMinutes() : string
Return values
string

getCronMonths()

public getCronMonths() : string
Return values
string

getDaysOfMonth()

public getDaysOfMonth() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDaysOfWeek()

public getDaysOfWeek() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHours()

public getHours() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMinutes()

public getMinutes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMonths()

public getMonths() : array<string|int, mixed>
Return values
array<string|int, mixed>

getText()

public getText(string $lang) : string
Parameters
$lang : string

'fr' or 'en'

Return values
string

getType()

public getType() : string
Return values
string

matchExact()

public matchExact(int|string|DateTime $date) : mixed
Parameters
$date : int|string|DateTime

matchWithMargin()

public matchWithMargin(int|string|DateTime $date[, int $minuteBefore = 0 ][, int $minuteAfter = 0 ]) : mixed
Parameters
$date : int|string|DateTime
$minuteBefore : int = 0
$minuteAfter : int = 0

setCron()

public setCron(string $cron) : $this
Parameters
$cron : string
Return values
$this

setDaysOfMonth()

public setDaysOfMonth(string|array<string|int, string> $dom) : $this
Parameters
$dom : string|array<string|int, string>
Return values
$this

setDaysOfWeek()

public setDaysOfWeek(string|array<string|int, string> $dow) : $this
Parameters
$dow : string|array<string|int, string>
Return values
$this

setHours()

public setHours(string|array<string|int, string> $hours) : $this
Parameters
$hours : string|array<string|int, string>
Return values
$this

setMinutes()

public setMinutes(string|array<string|int, string> $minutes) : $this
Parameters
$minutes : string|array<string|int, string>
Return values
$this

setMonths()

public setMonths(string|array<string|int, string> $months) : $this
Parameters
$months : string|array<string|int, string>
Return values
$this

arrayToCron()

protected arrayToCron(array<string|int, mixed> $array) : string
Parameters
$array : array<string|int, mixed>
Return values
string

cronToArray()

protected cronToArray(array<string|int, mixed>|string $string, int $min, int $max) : array<string|int, mixed>
Parameters
$string : array<string|int, mixed>|string
$min : int
$max : int
Return values
array<string|int, mixed>

parseDate()

protected parseDate(mixed $date, int &$min, int &$hour, int &$day, int &$month, int &$weekday) : DateTime
Parameters
$date : mixed
$min : int
$hour : int
$day : int
$month : int
$weekday : int
Return values
DateTime 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results