notifier / libraries / action-scheduler / lib / cron-expression / CronExpression_FieldInterface.php

CronExpression_FieldInterface.php in WANotifier for Forms and Actions 3.1.1, at libraries/action-scheduler/lib/cron-expression/CronExpression_FieldInterface.php

40 lines 1.1 KB

Raw Download Zip

1	<?php
2
3	/**
4	* CRON field interface
5	*
6	* @author Michael Dowling <mtdowling@gmail.com>
7	*/
8	interface CronExpression_FieldInterface
9	{
10	/**
11	* Check if the respective value of a DateTime field satisfies a CRON exp
12	*
13	* @param DateTime $date DateTime object to check
14	* @param string $value CRON expression to test against
15	*
16	* @return bool Returns TRUE if satisfied, FALSE otherwise
17	*/
18	public function isSatisfiedBy(DateTime $date, $value);
19
20	/**
21	* When a CRON expression is not satisfied, this method is used to increment
22	* or decrement a DateTime object by the unit of the cron field
23	*
24	* @param DateTime $date DateTime object to change
25	* @param bool $invert (optional) Set to TRUE to decrement
26	*
27	* @return CronExpression_FieldInterface
28	*/
29	public function increment(DateTime $date, $invert = false);
30
31	/**
32	* Validates a CRON expression for a given field
33	*
34	* @param string $value CRON expression value to validate
35	*
36	* @return bool Returns TRUE if valid, FALSE otherwise
37	*/
38	public function validate($value);
39	}
40