Execution.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Scheduler;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Scheduler\CronCommand\CronCommand;
 
class ‪Execution
{
    protected ‪$start;
 
    protected ‪$end;
 
    protected ‪$interval;
 
    protected ‪$multiple = false;
 
    protected ‪$cronCmd;
 
    protected ‪$isNewSingleExecution = false;
 
    /**********************************
     * Setters and getters
     **********************************/
    public function ‪setStart(‪$start)
    {
        $this->start = ‪$start;
    }
 
    public function ‪getStart()
    {
        return ‪$this->start;
    }
 
    public function ‪setEnd(‪$end)
    {
        $this->end = ‪$end;
    }
 
    public function ‪getEnd()
    {
        return ‪$this->end;
    }
 
    public function ‪setInterval(‪$interval)
    {
        $this->interval = ‪$interval;
    }
 
    public function ‪getInterval()
    {
        return ‪$this->interval;
    }
 
    public function ‪setMultiple(‪$multiple)
    {
        $this->multiple = ‪$multiple;
    }
 
    public function ‪getMultiple()
    {
        return ‪$this->multiple;
    }
 
    public function ‪setCronCmd($cmd)
    {
        $this->cronCmd = $cmd;
    }
 
    public function ‪getCronCmd()
    {
        return ‪$this->cronCmd;
    }
 
    public function ‪setIsNewSingleExecution(‪$isNewSingleExecution)
    {
        $this->isNewSingleExecution = ‪$isNewSingleExecution;
    }
 
    public function ‪getIsNewSingleExecution()
    {
        return ‪$this->isNewSingleExecution;
    }
 
    /**********************************
     * Execution calculations and logic
     **********************************/
    public function ‪getNextExecution()
    {
        if ($this->‪getIsNewSingleExecution()) {
            $this->‪setIsNewSingleExecution(false);
            return ‪$this->start;
        }
        if (!$this->‪isEnded()) {
            // If the schedule has not yet run out, find out the next date
            if (!$this->‪isStarted()) {
                // If the schedule hasn't started yet, next date is start date
                $date = ‪$this->start;
            } else {
                // If the schedule has already started, calculate next date
                if ($this->cronCmd) {
                    // If it uses cron-like syntax, calculate next date
                    $date = $this->‪getNextCronExecution();
                } elseif ($this->interval == 0) {
                    // If not and there's no interval either, it's a singe execution: use start date
                    $date = ‪$this->start;
                } else {
                    // Otherwise calculate date based on interval
                    $now = time();
                    $date = $now + $this->interval - ($now - ‪$this->start) % $this->interval;
                }
                // If date is in the future, throw an exception
                if (!empty($this->end) && $date > ‪$this->end) {
                    throw new \OutOfBoundsException('Next execution date is past end date.', 1250715528);
                }
            }
        } else {
            // The event has ended, throw an exception
            throw new \OutOfBoundsException('Task is past end date.', 1250715544);
        }
        return $date;
    }
 
    public function ‪getNextCronExecution()
    {
        ‪$cronCmd = GeneralUtility::makeInstance(CronCommand::class, $this->‪getCronCmd());
        ‪$cronCmd->calculateNextValue();
        return ‪$cronCmd->getTimestamp();
    }
 
    public function ‪isStarted()
    {
        return $this->start < time();
    }
 
    public function ‪isEnded()
    {
        if (empty($this->end)) {
            // If no end is defined, the schedule never ends
            $result = false;
        } else {
            // Otherwise check if end is in the past
            $result = $this->end < time();
        }
        return $result;
    }
}