Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Date time utilties | |
38 | */ | |
39 | class CRM_Utils_Time { | |
40 | ||
41 | /** | |
42 | * @var int, the seconds offset from the real world time | |
43 | */ | |
44 | static private $_delta = 0; | |
45 | ||
46 | /** | |
fe482240 | 47 | * Get the time. |
6a488035 | 48 | * |
77855840 TO |
49 | * @param string $returnFormat |
50 | * Format in which date is to be retrieved. | |
6a488035 TO |
51 | * |
52 | * @return date | |
53 | * | |
6a488035 | 54 | */ |
00be9182 | 55 | public static function getTime($returnFormat = 'YmdHis') { |
6a488035 TO |
56 | return date($returnFormat, self::getTimeRaw()); |
57 | } | |
58 | ||
59 | /** | |
fe482240 | 60 | * Get the time. |
6a488035 TO |
61 | * |
62 | * @return int, seconds since epoch | |
63 | */ | |
00be9182 | 64 | public static function getTimeRaw() { |
6a488035 TO |
65 | return time() + self::$_delta; |
66 | } | |
67 | ||
68 | /** | |
fe482240 | 69 | * Set the given time. |
6a488035 | 70 | * |
77855840 TO |
71 | * @param string $newDateTime |
72 | * A date formatted with strtotime. | |
73 | * @param string $returnFormat | |
74 | * Format in which date is to be retrieved. | |
6a488035 TO |
75 | * |
76 | * @return date | |
77 | * | |
6a488035 | 78 | */ |
00be9182 | 79 | public static function setTime($newDateTime, $returnFormat = 'YmdHis') { |
6a488035 TO |
80 | self::$_delta = strtotime($newDateTime) - time(); |
81 | return self::getTime($returnFormat); | |
82 | } | |
83 | ||
84 | /** | |
fe482240 | 85 | * Remove any time overrides. |
6a488035 | 86 | */ |
00be9182 | 87 | public static function resetTime() { |
6a488035 TO |
88 | self::$_delta = 0; |
89 | } | |
8010540a TO |
90 | |
91 | /** | |
92 | * Approximate time-comparison. $a and $b are considered equal if they | |
93 | * are within $threshold seconds of each other. | |
94 | * | |
77855840 TO |
95 | * @param string $a |
96 | * Time which can be parsed by strtotime. | |
97 | * @param string $b | |
98 | * Time which can be parsed by strtotime. | |
99 | * @param int $threshold | |
100 | * Maximum allowed difference (in seconds). | |
8010540a TO |
101 | * @return bool |
102 | */ | |
00be9182 | 103 | public static function isEqual($a, $b, $threshold = 0) { |
8010540a TO |
104 | $diff = strtotime($b) - strtotime($a); |
105 | return (abs($diff) <= $threshold); | |
106 | } | |
96025800 | 107 | |
6a488035 | 108 | } |