CRM/Utils/Time.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  */
  33
  34 /**
  35  * Date time utilties
  36  */
  37 class CRM_Utils_Time {
  38
  39   /**
  40    * @var int
  41    *   the seconds offset from the real world time
  42    */
  43   static private $_delta = 0;
  44
  45   /**
  46    * Get the time.
  47    *
  48    * @param string $returnFormat
  49    *   Format in which date is to be retrieved.
  50    *
  51    * @return date
  52    */
  53   public static function getTime($returnFormat = 'YmdHis') {
  54     return date($returnFormat, self::getTimeRaw());
  55   }
  56
  57   /**
  58    * Get the time.
  59    *
  60    * @return int
  61    *   seconds since epoch
  62    */
  63   public static function getTimeRaw() {
  64     return time() + self::$_delta;
  65   }
  66
  67   /**
  68    * Set the given time.
  69    *
  70    * @param string $newDateTime
  71    *   A date formatted with strtotime.
  72    * @param string $returnFormat
  73    *   Format in which date is to be retrieved.
  74    *
  75    * @return date
  76    */
  77   public static function setTime($newDateTime, $returnFormat = 'YmdHis') {
  78     self::$_delta = strtotime($newDateTime) - time();
  79     return self::getTime($returnFormat);
  80   }
  81
  82   /**
  83    * Remove any time overrides.
  84    */
  85   public static function resetTime() {
  86     self::$_delta = 0;
  87   }
  88
  89   /**
  90    * Approximate time-comparison. $a and $b are considered equal if they
  91    * are within $threshold seconds of each other.
  92    *
  93    * @param string $a
  94    *   Time which can be parsed by strtotime.
  95    * @param string $b
  96    *   Time which can be parsed by strtotime.
  97    * @param int $threshold
  98    *   Maximum allowed difference (in seconds).
  99    * @return bool
 100    */
 101   public static function isEqual($a, $b, $threshold = 0) {
 102     $diff = strtotime($b) - strtotime($a);
 103     return (abs($diff) <= $threshold);
 104   }
 105
 106 }