DayOfWeekField Class Reference

Inheritance diagram for DayOfWeekField:

Collaboration diagram for DayOfWeekField:

Public Member Functions
	isSatisfiedBy (DateTime $date, $value)
	increment (DateTime $date, $invert=false)
	validate ($value)
Public Member Functions inherited from AbstractField
	isSatisfied ($dateValue, $value)
	isRange ($value)
	isIncrementsOfRanges ($value)
	isInRange ($dateValue, $value)
	isInIncrementsOfRanges ($dateValue, $value)

Detailed Description

Day of week field. Allows: * / , - ? L #.

Days of the week can be represented as a number 0-7 (0|7 = Sunday) or as a three letter string: SUN, MON, TUE, WED, THU, FRI, SAT.

'L' stands for "last". It allows you to specify constructs such as "the last Friday" of a given month.

'#' is allowed for the day-of-week field, and must be followed by a number between one and five. It allows you to specify constructs such as "the second Friday" of a given month.

Author

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

Definition at line 19 of file DayOfWeekField.php.

Member Function Documentation

DayOfWeekField::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

}

Implements FieldInterface.

Definition at line 105 of file DayOfWeekField.php.

DayOfWeekField::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

}

Implements FieldInterface.

Definition at line 24 of file DayOfWeekField.php.

Here is the call graph for this function:

DayOfWeekField::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

}

Implements FieldInterface.

Definition at line 121 of file DayOfWeekField.php.

---

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

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