| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
static private $_delta = 0;
/**
- * Get the time
+ * Get the time.
*
- * @param string $returnFormat format in which date is to be retrieved
+ * @param string $returnFormat
+ * Format in which date is to be retrieved.
*
* @return date
*
- * @static
*/
public static function getTime($returnFormat = 'YmdHis') {
return date($returnFormat, self::getTimeRaw());
}
/**
- * Get the time
+ * Get the time.
*
* @return int, seconds since epoch
*/
}
/**
- * Set the given time
+ * Set the given time.
*
- * @param string $newDateTime a date formatted with strtotime
- * @param string $returnFormat format in which date is to be retrieved
+ * @param string $newDateTime
+ * A date formatted with strtotime.
+ * @param string $returnFormat
+ * Format in which date is to be retrieved.
*
* @return date
*
- * @static
*/
public static function setTime($newDateTime, $returnFormat = 'YmdHis') {
self::$_delta = strtotime($newDateTime) - time();
}
/**
- * Remove any time overrides
+ * Remove any time overrides.
*/
public static function resetTime() {
self::$_delta = 0;
* Approximate time-comparison. $a and $b are considered equal if they
* are within $threshold seconds of each other.
*
- * @param string $a time which can be parsed by strtotime
- * @param string $b time which can be parsed by strtotime
- * @param int $threshold maximum allowed difference (in seconds)
+ * @param string $a
+ * Time which can be parsed by strtotime.
+ * @param string $b
+ * Time which can be parsed by strtotime.
+ * @param int $threshold
+ * Maximum allowed difference (in seconds).
* @return bool
*/
public static function isEqual($a, $b, $threshold = 0) {
$diff = strtotime($b) - strtotime($a);
return (abs($diff) <= $threshold);
}
+
}