MonthField Class Reference

Inheritance diagram for MonthField:

Collaboration diagram for MonthField:

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

Month field. Allows: * , / -.

Author

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

Definition at line 8 of file MonthField.php.

Member Function Documentation

MonthField::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 31 of file MonthField.php.

MonthField::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 13 of file MonthField.php.

Here is the call graph for this function:

MonthField::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 59 of file MonthField.php.

---

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

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