123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404 |
- <?php
- /**
- * @package Grav\Common\Scheduler
- * @author Originally based on peppeocchi/php-cron-scheduler modified for Grav integration
- * @copyright Copyright (c) 2015 - 2022 Trilby Media, LLC. All rights reserved.
- * @license MIT License; see LICENSE file for details.
- */
- namespace Grav\Common\Scheduler;
- use Cron\CronExpression;
- use InvalidArgumentException;
- use function is_string;
- /**
- * Trait IntervalTrait
- * @package Grav\Common\Scheduler
- */
- trait IntervalTrait
- {
- /**
- * Set the Job execution time.
- *compo
- * @param string $expression
- * @return self
- */
- public function at($expression)
- {
- $this->at = $expression;
- $this->executionTime = CronExpression::factory($expression);
- return $this;
- }
- /**
- * Set the execution time to every minute.
- *
- * @return self
- */
- public function everyMinute()
- {
- return $this->at('* * * * *');
- }
- /**
- * Set the execution time to every hour.
- *
- * @param int|string $minute
- * @return self
- */
- public function hourly($minute = 0)
- {
- $c = $this->validateCronSequence($minute);
- return $this->at("{$c['minute']} * * * *");
- }
- /**
- * Set the execution time to once a day.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function daily($hour = 0, $minute = 0)
- {
- if (is_string($hour)) {
- $parts = explode(':', $hour);
- $hour = $parts[0];
- $minute = $parts[1] ?? '0';
- }
- $c = $this->validateCronSequence($minute, $hour);
- return $this->at("{$c['minute']} {$c['hour']} * * *");
- }
- /**
- * Set the execution time to once a week.
- *
- * @param int|string $weekday
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function weekly($weekday = 0, $hour = 0, $minute = 0)
- {
- if (is_string($hour)) {
- $parts = explode(':', $hour);
- $hour = $parts[0];
- $minute = $parts[1] ?? '0';
- }
- $c = $this->validateCronSequence($minute, $hour, null, null, $weekday);
- return $this->at("{$c['minute']} {$c['hour']} * * {$c['weekday']}");
- }
- /**
- * Set the execution time to once a month.
- *
- * @param int|string $month
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function monthly($month = '*', $day = 1, $hour = 0, $minute = 0)
- {
- if (is_string($hour)) {
- $parts = explode(':', $hour);
- $hour = $parts[0];
- $minute = $parts[1] ?? '0';
- }
- $c = $this->validateCronSequence($minute, $hour, $day, $month);
- return $this->at("{$c['minute']} {$c['hour']} {$c['day']} {$c['month']} *");
- }
- /**
- * Set the execution time to every Sunday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function sunday($hour = 0, $minute = 0)
- {
- return $this->weekly(0, $hour, $minute);
- }
- /**
- * Set the execution time to every Monday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function monday($hour = 0, $minute = 0)
- {
- return $this->weekly(1, $hour, $minute);
- }
- /**
- * Set the execution time to every Tuesday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function tuesday($hour = 0, $minute = 0)
- {
- return $this->weekly(2, $hour, $minute);
- }
- /**
- * Set the execution time to every Wednesday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function wednesday($hour = 0, $minute = 0)
- {
- return $this->weekly(3, $hour, $minute);
- }
- /**
- * Set the execution time to every Thursday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function thursday($hour = 0, $minute = 0)
- {
- return $this->weekly(4, $hour, $minute);
- }
- /**
- * Set the execution time to every Friday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function friday($hour = 0, $minute = 0)
- {
- return $this->weekly(5, $hour, $minute);
- }
- /**
- * Set the execution time to every Saturday.
- *
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function saturday($hour = 0, $minute = 0)
- {
- return $this->weekly(6, $hour, $minute);
- }
- /**
- * Set the execution time to every January.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function january($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(1, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every February.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function february($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(2, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every March.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function march($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(3, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every April.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function april($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(4, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every May.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function may($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(5, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every June.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function june($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(6, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every July.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function july($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(7, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every August.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function august($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(8, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every September.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function september($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(9, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every October.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function october($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(10, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every November.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function november($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(11, $day, $hour, $minute);
- }
- /**
- * Set the execution time to every December.
- *
- * @param int|string $day
- * @param int|string $hour
- * @param int|string $minute
- * @return self
- */
- public function december($day = 1, $hour = 0, $minute = 0)
- {
- return $this->monthly(12, $day, $hour, $minute);
- }
- /**
- * Validate sequence of cron expression.
- *
- * @param int|string|null $minute
- * @param int|string|null $hour
- * @param int|string|null $day
- * @param int|string|null $month
- * @param int|string|null $weekday
- * @return array
- */
- private function validateCronSequence($minute = null, $hour = null, $day = null, $month = null, $weekday = null)
- {
- return [
- 'minute' => $this->validateCronRange($minute, 0, 59),
- 'hour' => $this->validateCronRange($hour, 0, 23),
- 'day' => $this->validateCronRange($day, 1, 31),
- 'month' => $this->validateCronRange($month, 1, 12),
- 'weekday' => $this->validateCronRange($weekday, 0, 6),
- ];
- }
- /**
- * Validate sequence of cron expression.
- *
- * @param int|string|null $value
- * @param int $min
- * @param int $max
- * @return mixed
- */
- private function validateCronRange($value, $min, $max)
- {
- if ($value === null || $value === '*') {
- return '*';
- }
- if (! is_numeric($value) ||
- ! ($value >= $min && $value <= $max)
- ) {
- throw new InvalidArgumentException(
- "Invalid value: it should be '*' or between {$min} and {$max}."
- );
- }
- return $value;
- }
- }
|