Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
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 | /** | |
100fef9d | 47 | * Get the time |
6a488035 TO |
48 | * |
49 | * @param string $returnFormat format in which date is to be retrieved | |
50 | * | |
51 | * @return date | |
52 | * | |
53 | * @static | |
54 | */ | |
00be9182 | 55 | public static function getTime($returnFormat = 'YmdHis') { |
6a488035 TO |
56 | return date($returnFormat, self::getTimeRaw()); |
57 | } | |
58 | ||
59 | /** | |
60 | * Get the time | |
61 | * | |
62 | * @return int, seconds since epoch | |
63 | */ | |
00be9182 | 64 | public static function getTimeRaw() { |
6a488035 TO |
65 | return time() + self::$_delta; |
66 | } | |
67 | ||
68 | /** | |
100fef9d | 69 | * Set the given time |
6a488035 TO |
70 | * |
71 | * @param string $newDateTime a date formatted with strtotime | |
72 | * @param string $returnFormat format in which date is to be retrieved | |
73 | * | |
74 | * @return date | |
75 | * | |
76 | * @static | |
77 | */ | |
00be9182 | 78 | public static function setTime($newDateTime, $returnFormat = 'YmdHis') { |
6a488035 TO |
79 | self::$_delta = strtotime($newDateTime) - time(); |
80 | return self::getTime($returnFormat); | |
81 | } | |
82 | ||
83 | /** | |
84 | * Remove any time overrides | |
85 | */ | |
00be9182 | 86 | public static function resetTime() { |
6a488035 TO |
87 | self::$_delta = 0; |
88 | } | |
8010540a TO |
89 | |
90 | /** | |
91 | * Approximate time-comparison. $a and $b are considered equal if they | |
92 | * are within $threshold seconds of each other. | |
93 | * | |
94 | * @param string $a time which can be parsed by strtotime | |
95 | * @param string $b time which can be parsed by strtotime | |
96 | * @param int $threshold maximum allowed difference (in seconds) | |
97 | * @return bool | |
98 | */ | |
00be9182 | 99 | public static function isEqual($a, $b, $threshold = 0) { |
8010540a TO |
100 | $diff = strtotime($b) - strtotime($a); |
101 | return (abs($diff) <= $threshold); | |
102 | } | |
6a488035 | 103 | } |