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