\CronYearField

Year field. Allows: * , / -

Summary

Methods

Properties

Constants

isSatisfied()
isRange()
isIncrementsOfRanges()
isInRange()
isInIncrementsOfRanges()
getRangeForExpression()
isSatisfiedBy()
increment()
validate()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: vendor/mtdowling/cron-expression/src/Cron/YearField.php
Package: Default
Class hierarchy: \Cron\AbstractField

\Cron\YearField

Methods

isSatisfied()

isSatisfied(string  $dateValue, string  $value) : boolean

Check to see if a field is satisfied by a value

Parameters

string	$dateValue	Date value to check
string	$value	Value to test

Returns

boolean

isRange()

isRange(string  $value) : boolean

Check if a value is a range

Parameters

string

$value

Value to test

Returns

boolean

isIncrementsOfRanges()

isIncrementsOfRanges(string  $value) : boolean

Check if a value is an increments of ranges

Parameters

string

$value

Value to test

Returns

boolean

isInRange()

isInRange(string  $dateValue, string  $value) : boolean

Test if a value is within a range

Parameters

string	$dateValue	Set date value
string	$value	Value to test

Returns

boolean

isInIncrementsOfRanges()

isInIncrementsOfRanges(string  $dateValue, string  $value) : boolean

Test if a value is within an increments of ranges (offset[-to]/step size)

Parameters

string	$dateValue	Set date value
string	$value	Value to test

Returns

boolean

getRangeForExpression()

getRangeForExpression(string  $expression, integer  $max) : array

Returns a range of values for the given cron expression

Parameters

string	$expression	The expression to evaluate
integer	$max	Maximum offset for range

Returns

array

isSatisfiedBy()

isSatisfiedBy(\DateTime  $date,   $value)

Parameters

\DateTime	$date
	$value

increment()

increment(\DateTime  $date,   $invert = false)

Parameters

\DateTime	$date
	$invert

validate()

validate(  $value)

Parameters

$value