FieldInterface Interface Reference

Inheritance diagram for FieldInterface:

Public Member Functions
	isSatisfiedBy (DateTime $date, $value)
	increment (DateTime $date, $invert=false)
	validate ($value)

Detailed Description

CRON field interface.

Author

Michael Dowling mtdow.nosp@m.ling.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Definition at line 8 of file FieldInterface.php.

Member Function Documentation

FieldInterface::increment	(	DateTime	$date,
			$invert = false
	)

When a CRON expression is not satisfied, this method is used to increment or decrement a DateTime object by the unit of the cron field.

Parameters

DateTime	$date	DateTime object to change
bool	$invert	(optional) Set to TRUE to decrement

Returns

FieldInterface

Implemented in DayOfWeekField, DayOfMonthField, MonthField, HoursField, MinutesField, and YearField.

FieldInterface::isSatisfiedBy	(	DateTime	$date,
			$value
	)

Check if the respective value of a DateTime field satisfies a CRON exp.

Parameters

DateTime	$date	DateTime object to check
string	$value	CRON expression to test against

Returns

bool Returns TRUE if satisfied, FALSE otherwise

Implemented in DayOfMonthField, DayOfWeekField, HoursField, MinutesField, MonthField, and YearField.

FieldInterface::validate

(

$value

)

Validates a CRON expression for a given field.

Parameters

string

$value

CRON expression value to validate

Returns

bool Returns TRUE if valid, FALSE otherwise

Implemented in DayOfWeekField, DayOfMonthField, MonthField, YearField, HoursField, and MinutesField.

---

The documentation for this interface was generated from the following file:

• app/protected/modules/job/vendors/crontab/FieldInterface.php