Add CRM.sigfig utility

[civicrm-core.git] / CRM / Utils / Time.php

diff --git a/CRM/Utils/Time.php b/CRM/Utils/Time.php
index a70ad242676ea86fb0dfe454b935b4216ce5f7b2..99c75e9afcdc505590718a0cec9a021cc2a3d555 100644 (file)
--- a/CRM/Utils/Time.php
+++ b/CRM/Utils/Time.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -44,46 +44,47 @@ class CRM_Utils_Time {
   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
    */
-  static function getTime($returnFormat = 'YmdHis') {
+  public static function getTime($returnFormat = 'YmdHis') {
     return date($returnFormat, self::getTimeRaw());
   }
 
   /**
-   * Get the time
+   * Get the time.
    *
    * @return int, seconds since epoch
    */
-  static function getTimeRaw() {
+  public static function getTimeRaw() {
     return time() + self::$_delta;
   }
 
   /**
-   * 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
    */
-  static function setTime($newDateTime, $returnFormat = 'YmdHis') {
+  public static function setTime($newDateTime, $returnFormat = 'YmdHis') {
     self::$_delta = strtotime($newDateTime) - time();
     return self::getTime($returnFormat);
   }
 
   /**
-   * Remove any time overrides
+   * Remove any time overrides.
    */
-  static function resetTime() {
+  public static function resetTime() {
     self::$_delta = 0;
   }
 
@@ -91,14 +92,17 @@ class CRM_Utils_Time {
    * 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
    */
-  static function isEqual($a, $b, $threshold = 0) {
+  public static function isEqual($a, $b, $threshold = 0) {
     $diff = strtotime($b) - strtotime($a);
     return (abs($diff) <= $threshold);
   }
-}
 
+}