Static/PhpInclude/FareOfficeLib/General/PhpCronTab.class.php

Go to the documentation of this file.

<?php
class PhpCronTab
{
  const EVERY_MINUTE    = '*/1 * * * *';
  const EVERY_5_MINUTE  = '*/5 * * * *';
  const EVERY_15_MINUTE = '*/15 * * * *';
  const EVERY_30_MINUTE = '*/30 * * * *';
  const EVERY_HOUR      = '* */1 * * *';
  const EVERY_DAY       = '0 21 * * *';
  const EVERY_WEEK      = '0 22 * * 1';

  public function __construct()
  {
    $this->scheduleList = array();
    $this->setCurrentTime(time());
  }

  public function addUnixFormat($defined_)
  {
    $arr = explode(' ', $defined_);

    // @todo
    //assertLog(count($arr) == 5, EL_LEVEL_3, ECAT_DIAGNOSTIC, 'Not the right number of arguments: ' . count($arr) . ' ' . $defined_);

    $this->addUnixFormatEx($arr[0], $arr[1], $arr[2], $arr[3], $arr[4]);
  }

  public function addUnixFormatEx($minute_, $hour_, $dayOfMonth_, $month_, $dayOfWeek_)
  {
    $this->scheduleList[] = array
    (
      'minute'        => ltrim($minute_, '0'),
      'hour'          => ltrim($hour_, '0'),
      'day_of_month'  => ltrim($dayOfMonth_, '0'),
      'month'         => ltrim($month_, '0'),
      'day_of_week'   => ltrim($dayOfWeek_, '0')
    );
  }

  public function clearUnixFormat()
  {
    $this->scheduleList = array();
  }

  public function isTimeToExecute()
  {
    if (!empty($this->scheduleList))
    {
      $currentTime = $this->_getCurrentTimeArr();

      foreach ($this->scheduleList as $schedule)
      {
        if
        (
          $this->_checkClock($currentTime['minute'], $schedule['minute']) &&
          $this->_checkClock($currentTime['hour'], $schedule['hour']) &&
          $this->_checkClock($currentTime['day_of_month'], $schedule['day_of_month']) &&
          $this->_checkClock($currentTime['month'], $schedule['month']) &&
          $this->_checkClock($currentTime['day_of_week'], $schedule['day_of_week'])
        )
        {
          return true;
        }
      }
      return false;
    }
    else
    {
      // If no sceduleList are configured, always execute
      return true;
    }
  }

  public function setCurrentTime($time_)
  {
    $this->_currentTime = $time_;
  }

  public function getCurrentTime()
  {
    return $this->_currentTime;
  }

  private function _getCurrentTimeArr()
  {
    return array
    (
      'minute'        => ltrim(date('i', $this->getCurrentTime()), '0'),
      'hour'          => ltrim(date('G', $this->getCurrentTime()), '0'),
      'day_of_month'  => ltrim(date('d', $this->getCurrentTime()), '0'),
      'month'         => ltrim(date('n', $this->getCurrentTime()), '0'),
      'day_of_week'   => ltrim(date('w', $this->getCurrentTime()), '0')
    );
  }

  private function _checkClock($currentClock_, $testClock_)
  {
    $testClockArr = array();

    // * always execute this.
    if ($testClock_ == '*')
    {
      return true;
    }

    // If same value
    elseif ($currentClock_ == $testClock_)
    {
      return true;
    }

    // Ranged values, 1-10 means all values from 1 to 10.
    elseif (strpos($testClock_, '-') !== false)
    {
      $numberRange = explode('-', $testClock_);
      if
      (
        count($numberRange) == 2 &&
        $currentClock_ >= $numberRange[0] &&
        $currentClock_ <= $numberRange[1]
      )
      {
        return true;
      }
    }

    // Will rebuild to real values in an array.
    // */3 will be 0,3,6,9,12,15,18,21 etc.
    elseif (strpos($testClock_, '/') !== false)
    {
      $skipNumber = explode('/', $testClock_);
      if ($skipNumber[0] == '*')
      {
        for($i = 0; $i < 60; $i+=$skipNumber[1])
        {
          $testClockArr[$i] = true;
        }
      }
    }

    // 1,3,7,9 will be expanded to an array.
    elseif (strpos($testClock_, ',') !== false)
    {
      $testClockArr = explode(',', $testClock_);
      $testClockArr = array_flip($testClockArr);
    }

    //
    if (!empty($testClockArr) && array_key_exists($currentClock_,  $testClockArr))
    {
      return true;
    }

    return false;
  }

  private function _checkDayOfMonth($dayOfMonth_, $scheduleDayOfMonth_)
  {
    if ('*' == $scheduleDayOfMonth_ || $dayOfMonth_ == $scheduleDayOfMonth_)
    {
      return true;
    }
    else
    {
      return false;
    }
  }

  private function _checkMonth($currentMonth_, $scheduleDMonth_)
  {
    if ('*' == $scheduleDMonth_ || $currentMonth_ == $scheduleDMonth_)
    {
      return true;
    }
    else
    {
      return false;
    }
  }

  private function _checkDayOfWeek($dayOfWeek_, $scheduledDayOfWeek_)
  {
    if ('*' == $scheduledDayOfWeek_ || $dayOfWeek_ == $scheduledDayOfWeek_)
    {
      return true;
    }
    else
    {
      return false;
    }
  }

  private $scheduleList;
}

?>

---