[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/dragonmantank/cron-expression/src/Cron/ -> FieldInterface.php (summary)

(no description)

File Size: 46 lines (1 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FieldInterface:: (3 methods):
  isSatisfiedBy()
  increment()
  validate()


Interface: FieldInterface  - X-Ref

CRON field interface.

isSatisfiedBy(DateTimeInterface $date, $value, bool $invert)   X-Ref
Check if the respective value of a DateTime field satisfies a CRON exp.

param: DateTimeInterface $date  DateTime object to check
param: string            $value CRON expression to test against
return: bool Returns TRUE if satisfied, FALSE otherwise

increment(DateTimeInterface &$date, $invert = false, $parts = null)   X-Ref
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.

param: DateTimeInterface $date DateTime object to change
param: bool $invert (optional) Set to TRUE to decrement
param: string|null $parts (optional) Set parts to use
return: FieldInterface

validate(string $value)   X-Ref
Validates a CRON expression for a given field.

param: string $value CRON expression value to validate
return: bool Returns TRUE if valid, FALSE otherwise



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer