CRM/Utils/Date.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2018                                |
   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
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 /**
  35  * Date utilties
  36  */
  37 class CRM_Utils_Date {
  38
  39   /**
  40    * Format a date by padding it with leading '0'.
  41    *
  42    * @param array $date
  43    *   ('Y', 'M', 'd').
  44    * @param string $separator
  45    *   The seperator to use when formatting the date.
  46    * @param int|string $invalidDate what to return if the date is invalid
  47    *
  48    * @return string
  49    *   formatted string for date
  50    */
  51   public static function format($date, $separator = '', $invalidDate = 0) {
  52     if (is_numeric($date) &&
  53       ((strlen($date) == 8) || (strlen($date) == 14))
  54     ) {
  55       return $date;
  56     }
  57
  58     if (!is_array($date) ||
  59       CRM_Utils_System::isNull($date) ||
  60       empty($date['Y'])
  61     ) {
  62       return $invalidDate;
  63     }
  64
  65     $date['Y'] = (int ) $date['Y'];
  66     if ($date['Y'] < 1000 || $date['Y'] > 2999) {
  67       return $invalidDate;
  68     }
  69
  70     if (array_key_exists('m', $date)) {
  71       $date['M'] = $date['m'];
  72     }
  73     elseif (array_key_exists('F', $date)) {
  74       $date['M'] = $date['F'];
  75     }
  76
  77     if (!empty($date['M'])) {
  78       $date['M'] = (int ) $date['M'];
  79       if ($date['M'] < 1 || $date['M'] > 12) {
  80         return $invalidDate;
  81       }
  82     }
  83     else {
  84       $date['M'] = 1;
  85     }
  86
  87     if (!empty($date['d'])) {
  88       $date['d'] = (int ) $date['d'];
  89     }
  90     else {
  91       $date['d'] = 1;
  92     }
  93
  94     if (!checkdate($date['M'], $date['d'], $date['Y'])) {
  95       return $invalidDate;
  96     }
  97
  98     $date['M'] = sprintf('%02d', $date['M']);
  99     $date['d'] = sprintf('%02d', $date['d']);
 100
 101     $time = '';
 102     if (CRM_Utils_Array::value('H', $date) != NULL ||
 103       CRM_Utils_Array::value('h', $date) != NULL ||
 104       CRM_Utils_Array::value('i', $date) != NULL ||
 105       CRM_Utils_Array::value('s', $date) != NULL
 106     ) {
 107       // we have time too..
 108       if (!empty($date['h'])) {
 109         if (CRM_Utils_Array::value('A', $date) == 'PM' or CRM_Utils_Array::value('a', $date) == 'pm') {
 110           if ($date['h'] != 12) {
 111             $date['h'] = $date['h'] + 12;
 112           }
 113         }
 114         if ((CRM_Utils_Array::value('A', $date) == 'AM' or CRM_Utils_Array::value('a', $date) == 'am') &&
 115           CRM_Utils_Array::value('h', $date) == 12
 116         ) {
 117           $date['h'] = '00';
 118         }
 119
 120         $date['h'] = (int ) $date['h'];
 121       }
 122       else {
 123         $date['h'] = 0;
 124       }
 125
 126       // in 24-hour format the hour is under the 'H' key
 127       if (!empty($date['H'])) {
 128         $date['H'] = (int) $date['H'];
 129       }
 130       else {
 131         $date['H'] = 0;
 132       }
 133
 134       if (!empty($date['i'])) {
 135         $date['i'] = (int ) $date['i'];
 136       }
 137       else {
 138         $date['i'] = 0;
 139       }
 140
 141       if ($date['h'] == 0 && $date['H'] != 0) {
 142         $date['h'] = $date['H'];
 143       }
 144
 145       if (!empty($date['s'])) {
 146         $date['s'] = (int ) $date['s'];
 147       }
 148       else {
 149         $date['s'] = 0;
 150       }
 151
 152       $date['h'] = sprintf('%02d', $date['h']);
 153       $date['i'] = sprintf('%02d', $date['i']);
 154       $date['s'] = sprintf('%02d', $date['s']);
 155
 156       if ($separator) {
 157         $time = '&nbsp;';
 158       }
 159       $time .= $date['h'] . $separator . $date['i'] . $separator . $date['s'];
 160     }
 161
 162     return $date['Y'] . $separator . $date['M'] . $separator . $date['d'] . $time;
 163   }
 164
 165   /**
 166    * Return abbreviated weekday names according to the locale.
 167    *
 168    * Array will be in localized order according to 'weekBegins' setting,
 169    * but array keys will always match to:
 170    * 0 => Sun
 171    * 1 => Mon
 172    * etc.
 173    *
 174    * @return array
 175    *   0-based array with abbreviated weekday names
 176    *
 177    */
 178   public static function getAbbrWeekdayNames() {
 179     static $days = array();
 180     if (!$days) {
 181       // First day of the week
 182       $firstDay = Civi::settings()->get('weekBegins');
 183
 184       // set LC_TIME and build the arrays from locale-provided names
 185       // June 1st, 1970 was a Monday
 186       CRM_Core_I18n::setLcTime();
 187       for ($i = $firstDay; count($days) < 7; $i = $i > 5 ? 0 : $i + 1) {
 188         $days[$i] = strftime('%a', mktime(0, 0, 0, 6, $i, 1970));
 189       }
 190     }
 191     return $days;
 192   }
 193
 194   /**
 195    * Return full weekday names according to the locale.
 196    *
 197    * Array will be in localized order according to 'weekBegins' setting,
 198    * but array keys will always match to:
 199    * 0 => Sunday
 200    * 1 => Monday
 201    * etc.
 202    *
 203    * @return array
 204    *   0-based array with full weekday names
 205    *
 206    */
 207   public static function getFullWeekdayNames() {
 208     static $days = array();
 209     if (!$days) {
 210       // First day of the week
 211       $firstDay = Civi::settings()->get('weekBegins');
 212
 213       // set LC_TIME and build the arrays from locale-provided names
 214       // June 1st, 1970 was a Monday
 215       CRM_Core_I18n::setLcTime();
 216       for ($i = $firstDay; count($days) < 7; $i = $i > 5 ? 0 : $i + 1) {
 217         $days[$i] = strftime('%A', mktime(0, 0, 0, 6, $i, 1970));
 218       }
 219     }
 220     return $days;
 221   }
 222
 223   /**
 224    * Return abbreviated month names according to the locale.
 225    *
 226    * @param bool $month
 227    *
 228    * @return array
 229    *   1-based array with abbreviated month names
 230    *
 231    */
 232   public static function &getAbbrMonthNames($month = FALSE) {
 233     static $abbrMonthNames;
 234     if (!isset($abbrMonthNames)) {
 235
 236       // set LC_TIME and build the arrays from locale-provided names
 237       CRM_Core_I18n::setLcTime();
 238       for ($i = 1; $i <= 12; $i++) {
 239         $abbrMonthNames[$i] = strftime('%b', mktime(0, 0, 0, $i, 10, 1970));
 240       }
 241     }
 242     if ($month) {
 243       return $abbrMonthNames[$month];
 244     }
 245     return $abbrMonthNames;
 246   }
 247
 248   /**
 249    * Return full month names according to the locale.
 250    *
 251    * @return array
 252    *   1-based array with full month names
 253    *
 254    */
 255   public static function &getFullMonthNames() {
 256     static $fullMonthNames;
 257     if (!isset($fullMonthNames)) {
 258
 259       // set LC_TIME and build the arrays from locale-provided names
 260       CRM_Core_I18n::setLcTime();
 261       for ($i = 1; $i <= 12; $i++) {
 262         $fullMonthNames[$i] = strftime('%B', mktime(0, 0, 0, $i, 10, 1970));
 263       }
 264     }
 265     return $fullMonthNames;
 266   }
 267
 268   /**
 269    * @param $string
 270    *
 271    * @return int
 272    */
 273   public static function unixTime($string) {
 274     if (empty($string)) {
 275       return 0;
 276     }
 277     $parsedDate = date_parse($string);
 278     return mktime(CRM_Utils_Array::value('hour', $parsedDate),
 279       CRM_Utils_Array::value('minute', $parsedDate),
 280       59,
 281       CRM_Utils_Array::value('month', $parsedDate),
 282       CRM_Utils_Array::value('day', $parsedDate),
 283       CRM_Utils_Array::value('year', $parsedDate)
 284     );
 285   }
 286
 287   /**
 288    * Create a date and time string in a provided format.
 289    *
 290    * %b - abbreviated month name ('Jan'..'Dec')
 291    * %B - full month name ('January'..'December')
 292    * %d - day of the month as a decimal number, 0-padded ('01'..'31')
 293    * %e - day of the month as a decimal number, blank-padded (' 1'..'31')
 294    * %E - day of the month as a decimal number ('1'..'31')
 295    * %f - English ordinal suffix for the day of the month ('st', 'nd', 'rd', 'th')
 296    * %H - hour in 24-hour format, 0-padded ('00'..'23')
 297    * %I - hour in 12-hour format, 0-padded ('01'..'12')
 298    * %k - hour in 24-hour format, blank-padded (' 0'..'23')
 299    * %l - hour in 12-hour format, blank-padded (' 1'..'12')
 300    * %m - month as a decimal number, 0-padded ('01'..'12')
 301    * %M - minute, 0-padded ('00'..'60')
 302    * %p - lowercase ante/post meridiem ('am', 'pm')
 303    * %P - uppercase ante/post meridiem ('AM', 'PM')
 304    * %Y - year as a decimal number including the century ('2005')
 305    *
 306    * @param string $dateString
 307    *   Date and time in 'YYYY-MM-DD hh:mm:ss' format.
 308    * @param string $format
 309    *   The output format.
 310    * @param array $dateParts
 311    *   An array with the desired date parts.
 312    *
 313    * @return string
 314    *   the $format-formatted $date
 315    */
 316   public static function customFormat($dateString, $format = NULL, $dateParts = NULL) {
 317     // 1-based (January) month names arrays
 318     $abbrMonths = self::getAbbrMonthNames();
 319     $fullMonths = self::getFullMonthNames();
 320
 321     if (!$format) {
 322       $config = CRM_Core_Config::singleton();
 323
 324       if ($dateParts) {
 325         if (array_intersect(array('h', 'H'), $dateParts)) {
 326           $format = $config->dateformatDatetime;
 327         }
 328         elseif (array_intersect(array('d', 'j'), $dateParts)) {
 329           $format = $config->dateformatFull;
 330         }
 331         elseif (array_intersect(array('m', 'M'), $dateParts)) {
 332           $format = $config->dateformatPartial;
 333         }
 334         else {
 335           $format = $config->dateformatYear;
 336         }
 337       }
 338       else {
 339         if (strpos($dateString, '-')) {
 340           $month = (int) substr($dateString, 5, 2);
 341           $day = (int) substr($dateString, 8, 2);
 342         }
 343         else {
 344           $month = (int) substr($dateString, 4, 2);
 345           $day = (int) substr($dateString, 6, 2);
 346         }
 347
 348         if (strlen($dateString) > 10) {
 349           $format = $config->dateformatDatetime;
 350         }
 351         elseif ($day > 0) {
 352           $format = $config->dateformatFull;
 353         }
 354         elseif ($month > 0) {
 355           $format = $config->dateformatPartial;
 356         }
 357         else {
 358           $format = $config->dateformatYear;
 359         }
 360       }
 361     }
 362
 363     if (!CRM_Utils_System::isNull($dateString)) {
 364       if (strpos($dateString, '-')) {
 365         $year = (int) substr($dateString, 0, 4);
 366         $month = (int) substr($dateString, 5, 2);
 367         $day = (int) substr($dateString, 8, 2);
 368
 369         $hour24 = (int) substr($dateString, 11, 2);
 370         $minute = (int) substr($dateString, 14, 2);
 371       }
 372       else {
 373         $year = (int) substr($dateString, 0, 4);
 374         $month = (int) substr($dateString, 4, 2);
 375         $day = (int) substr($dateString, 6, 2);
 376
 377         $hour24 = (int) substr($dateString, 8, 2);
 378         $minute = (int) substr($dateString, 10, 2);
 379       }
 380
 381       if ($day % 10 == 1 and $day != 11) {
 382         $suffix = 'st';
 383       }
 384       elseif ($day % 10 == 2 and $day != 12) {
 385         $suffix = 'nd';
 386       }
 387       elseif ($day % 10 == 3 and $day != 13) {
 388         $suffix = 'rd';
 389       }
 390       else {
 391         $suffix = 'th';
 392       }
 393
 394       if ($hour24 < 12) {
 395         if ($hour24 == 00) {
 396           $hour12 = 12;
 397         }
 398         else {
 399           $hour12 = $hour24;
 400         }
 401         $type = 'AM';
 402       }
 403       else {
 404         if ($hour24 == 12) {
 405           $hour12 = 12;
 406         }
 407         else {
 408           $hour12 = $hour24 - 12;
 409         }
 410         $type = 'PM';
 411       }
 412
 413       $date = array(
 414         '%b' => CRM_Utils_Array::value($month, $abbrMonths),
 415         '%B' => CRM_Utils_Array::value($month, $fullMonths),
 416         '%d' => $day > 9 ? $day : '0' . $day,
 417         '%e' => $day > 9 ? $day : ' ' . $day,
 418         '%E' => $day,
 419         '%f' => $suffix,
 420         '%H' => $hour24 > 9 ? $hour24 : '0' . $hour24,
 421         '%h' => $hour12 > 9 ? $hour12 : '0' . $hour12,
 422         '%I' => $hour12 > 9 ? $hour12 : '0' . $hour12,
 423         '%k' => $hour24 > 9 ? $hour24 : ' ' . $hour24,
 424         '%l' => $hour12 > 9 ? $hour12 : ' ' . $hour12,
 425         '%m' => $month > 9 ? $month : '0' . $month,
 426         '%M' => $minute > 9 ? $minute : '0' . $minute,
 427         '%i' => $minute > 9 ? $minute : '0' . $minute,
 428         '%p' => strtolower($type),
 429         '%P' => $type,
 430         '%A' => $type,
 431         '%Y' => $year,
 432       );
 433
 434       return strtr($format, $date);
 435     }
 436     else {
 437       return '';
 438     }
 439   }
 440
 441   /**
 442    * Converts the date/datetime from MySQL format to ISO format
 443    *
 444    * @param string $mysql
 445    *   Date/datetime in MySQL format.
 446    *
 447    * @return string
 448    *   date/datetime in ISO format
 449    */
 450   public static function mysqlToIso($mysql) {
 451     $year = substr($mysql, 0, 4);
 452     $month = substr($mysql, 4, 2);
 453     $day = substr($mysql, 6, 2);
 454     $hour = substr($mysql, 8, 2);
 455     $minute = substr($mysql, 10, 2);
 456     $second = substr($mysql, 12, 2);
 457
 458     $iso = '';
 459     if ($year) {
 460       $iso .= "$year";
 461     }
 462     if ($month) {
 463       $iso .= "-$month";
 464       if ($day) {
 465         $iso .= "-$day";
 466       }
 467     }
 468
 469     if ($hour) {
 470       $iso .= " $hour";
 471       if ($minute) {
 472         $iso .= ":$minute";
 473         if ($second) {
 474           $iso .= ":$second";
 475         }
 476       }
 477     }
 478     return $iso;
 479   }
 480
 481   /**
 482    * Converts the date/datetime from ISO format to MySQL format
 483    * Note that until CRM-14986/ 4.4.7 this was required whenever the pattern $dao->find(TRUE): $dao->save(); was
 484    * used to update an object with a date field was used. The DAO now checks for a '-' in date field strings
 485    * & runs this function if the - appears - meaning it is likely redundant in the form & BAO layers
 486    *
 487    * @param string $iso
 488    *   Date/datetime in ISO format.
 489    *
 490    * @return string
 491    *   date/datetime in MySQL format
 492    */
 493   public static function isoToMysql($iso) {
 494     $dropArray = array('-' => '', ':' => '', ' ' => '');
 495     return strtr($iso, $dropArray);
 496   }
 497
 498   /**
 499    * Converts the any given date to default date format.
 500    *
 501    * @param array $params
 502    *   Has given date-format.
 503    * @param int $dateType
 504    *   Type of date.
 505    * @param string $dateParam
 506    *   Index of params.
 507    *
 508    * @return bool
 509    */
 510   public static function convertToDefaultDate(&$params, $dateType, $dateParam) {
 511     $now = getdate();
 512     $cen = substr($now['year'], 0, 2);
 513     $prevCen = $cen - 1;
 514
 515     $value = NULL;
 516     if (!empty($params[$dateParam])) {
 517       // suppress hh:mm or hh:mm:ss if it exists CRM-7957
 518       $value = preg_replace("/(\s(([01]\d)|[2][0-3])(:([0-5]\d)){1,2})$/", "", $params[$dateParam]);
 519     }
 520
 521     switch ($dateType) {
 522       case 1:
 523         if (!preg_match('/^\d\d\d\d-?(\d|\d\d)-?(\d|\d\d)$/', $value)) {
 524           return FALSE;
 525         }
 526         break;
 527
 528       case 2:
 529         if (!preg_match('/^(\d|\d\d)[-\/](\d|\d\d)[-\/]\d\d$/', $value)) {
 530           return FALSE;
 531         }
 532         break;
 533
 534       case 4:
 535         if (!preg_match('/^(\d|\d\d)[-\/](\d|\d\d)[-\/]\d\d\d\d$/', $value)) {
 536           return FALSE;
 537         }
 538         break;
 539
 540       case 8:
 541         if (!preg_match('/^[A-Za-z]*.[ \t]?\d\d\,[ \t]?\d\d\d\d$/', $value)) {
 542           return FALSE;
 543         }
 544         break;
 545
 546       case 16:
 547         if (!preg_match('/^\d\d-[A-Za-z]{3}.*-\d\d$/', $value) && !preg_match('/^\d\d[-\/]\d\d[-\/]\d\d$/', $value)) {
 548           return FALSE;
 549         }
 550         break;
 551
 552       case 32:
 553         if (!preg_match('/^(\d|\d\d)[-\/](\d|\d\d)[-\/]\d\d\d\d/', $value)) {
 554           return FALSE;
 555         }
 556         break;
 557     }
 558
 559     if ($dateType == 1) {
 560       $formattedDate = explode("-", $value);
 561       if (count($formattedDate) == 3) {
 562         $year = (int) $formattedDate[0];
 563         $month = (int) $formattedDate[1];
 564         $day = (int) $formattedDate[2];
 565       }
 566       elseif (count($formattedDate) == 1 && (strlen($value) == 8)) {
 567         return TRUE;
 568       }
 569       else {
 570         return FALSE;
 571       }
 572     }
 573
 574     if ($dateType == 2 || $dateType == 4) {
 575       $formattedDate = explode("/", $value);
 576       if (count($formattedDate) != 3) {
 577         $formattedDate = explode("-", $value);
 578       }
 579       if (count($formattedDate) == 3) {
 580         $year = (int) $formattedDate[2];
 581         $month = (int) $formattedDate[0];
 582         $day = (int) $formattedDate[1];
 583       }
 584       else {
 585         return FALSE;
 586       }
 587     }
 588     if ($dateType == 8) {
 589       $dateArray = explode(' ', $value);
 590       // ignore comma(,)
 591       $dateArray[1] = (int) substr($dateArray[1], 0, 2);
 592
 593       $monthInt = 0;
 594       $fullMonths = self::getFullMonthNames();
 595       foreach ($fullMonths as $key => $val) {
 596         if (strtolower($dateArray[0]) == strtolower($val)) {
 597           $monthInt = $key;
 598           break;
 599         }
 600       }
 601       if (!$monthInt) {
 602         $abbrMonths = self::getAbbrMonthNames();
 603         foreach ($abbrMonths as $key => $val) {
 604           if (strtolower(trim($dateArray[0], ".")) == strtolower($val)) {
 605             $monthInt = $key;
 606             break;
 607           }
 608         }
 609       }
 610       $year = (int) $dateArray[2];
 611       $day = (int) $dateArray[1];
 612       $month = (int) $monthInt;
 613     }
 614     if ($dateType == 16) {
 615       $dateArray = explode('-', $value);
 616       if (count($dateArray) != 3) {
 617         $dateArray = explode('/', $value);
 618       }
 619
 620       if (count($dateArray) == 3) {
 621         $monthInt = 0;
 622         $fullMonths = self::getFullMonthNames();
 623         foreach ($fullMonths as $key => $val) {
 624           if (strtolower($dateArray[1]) == strtolower($val)) {
 625             $monthInt = $key;
 626             break;
 627           }
 628         }
 629         if (!$monthInt) {
 630           $abbrMonths = self::getAbbrMonthNames();
 631           foreach ($abbrMonths as $key => $val) {
 632             if (strtolower(trim($dateArray[1], ".")) == strtolower($val)) {
 633               $monthInt = $key;
 634               break;
 635             }
 636           }
 637         }
 638         if (!$monthInt) {
 639           $monthInt = $dateArray[1];
 640         }
 641
 642         $year = (int) $dateArray[2];
 643         $day = (int) $dateArray[0];
 644         $month = (int) $monthInt;
 645       }
 646       else {
 647         return FALSE;
 648       }
 649     }
 650     if ($dateType == 32) {
 651       $formattedDate = explode("/", $value);
 652       if (count($formattedDate) == 3) {
 653         $year = (int) $formattedDate[2];
 654         $month = (int) $formattedDate[1];
 655         $day = (int) $formattedDate[0];
 656       }
 657       else {
 658         return FALSE;
 659       }
 660     }
 661
 662     $month = ($month < 10) ? "0" . "$month" : $month;
 663     $day = ($day < 10) ? "0" . "$day" : $day;
 664
 665     $year = (int ) $year;
 666     // simple heuristic to determine what century to use
 667     // 00 - 20 is always 2000 - 2020
 668     // 21 - 99 is always 1921 - 1999
 669     if ($year < 21) {
 670       $year = (strlen($year) == 1) ? $cen . '0' . $year : $cen . $year;
 671     }
 672     elseif ($year < 100) {
 673       $year = $prevCen . $year;
 674     }
 675
 676     if ($params[$dateParam]) {
 677       $params[$dateParam] = "$year$month$day";
 678     }
 679     // if month is invalid return as error
 680     if ($month !== '00' && $month <= 12) {
 681       return TRUE;
 682     }
 683     return FALSE;
 684   }
 685
 686   /**
 687    * @param $date
 688    *
 689    * @return bool
 690    */
 691   public static function isDate(&$date) {
 692     if (CRM_Utils_System::isNull($date)) {
 693       return FALSE;
 694     }
 695     return TRUE;
 696   }
 697
 698   /**
 699    * @param null $timeStamp
 700    *
 701    * @return bool|string
 702    */
 703   public static function currentDBDate($timeStamp = NULL) {
 704     return $timeStamp ? date('YmdHis', $timeStamp) : date('YmdHis');
 705   }
 706
 707   /**
 708    * @param $date
 709    * @param null $now
 710    *
 711    * @return bool
 712    */
 713   public static function overdue($date, $now = NULL) {
 714     $mysqlDate = self::isoToMysql($date);
 715     if (!$now) {
 716       $now = self::currentDBDate();
 717     }
 718     else {
 719       $now = self::isoToMysql($now);
 720     }
 721
 722     return ($mysqlDate >= $now) ? FALSE : TRUE;
 723   }
 724
 725   /**
 726    * Get customized today.
 727    *
 728    * This function is used for getting customized today. To get
 729    * actuall today pass 'dayParams' as null. or else pass the day,
 730    * month, year values as array values
 731    * Example: $dayParams = array(
 732    * 'day' => '25', 'month' => '10',
 733    *                              'year' => '2007' );
 734    *
 735    * @param array $dayParams of the day, month, year.
 736    *   Array of the day, month, year.
 737    *                             values.
 738    * @param string $format
 739    *   Expected date format( default.
 740    *                             format is 2007-12-21 )
 741    *
 742    * @return string
 743    *   Return the customized today's date (Y-m-d)
 744    */
 745   public static function getToday($dayParams = NULL, $format = "Y-m-d") {
 746     if (is_null($dayParams) || empty($dayParams)) {
 747       $today = date($format);
 748     }
 749     else {
 750       $today = date($format, mktime(0, 0, 0,
 751         $dayParams['month'],
 752         $dayParams['day'],
 753         $dayParams['year']
 754       ));
 755     }
 756
 757     return $today;
 758   }
 759
 760   /**
 761    * Find whether today's date lies in
 762    * the given range
 763    *
 764    * @param date $startDate
 765    *   Start date for the range.
 766    * @param date $endDate
 767    *   End date for the range.
 768    *
 769    * @return bool
 770    *   true if today's date is in the given date range
 771    */
 772   public static function getRange($startDate, $endDate) {
 773     $today = date("Y-m-d");
 774     $mysqlStartDate = self::isoToMysql($startDate);
 775     $mysqlEndDate = self::isoToMysql($endDate);
 776     $mysqlToday = self::isoToMysql($today);
 777
 778     if ((isset($mysqlStartDate) && isset($mysqlEndDate)) && (($mysqlToday >= $mysqlStartDate) && ($mysqlToday <= $mysqlEndDate))) {
 779       return TRUE;
 780     }
 781     elseif ((isset($mysqlStartDate) && !isset($mysqlEndDate)) && (($mysqlToday >= $mysqlStartDate))) {
 782       return TRUE;
 783     }
 784     elseif ((!isset($mysqlStartDate) && isset($mysqlEndDate)) && (($mysqlToday <= $mysqlEndDate))) {
 785       return TRUE;
 786     }
 787     return FALSE;
 788   }
 789
 790   /**
 791    * Get start date and end from
 792    * the given relative term and unit
 793    *
 794    * @param string $relative Relative format in the format term.unit.
 795    *   Eg: previous.day
 796    *
 797    * @param string $from
 798    * @param string $to
 799    * @param string $fromTime
 800    * @param string $toTime
 801    *
 802    * @return array
 803    *   start date, end date
 804    */
 805   public static function getFromTo($relative, $from, $to, $fromTime = NULL, $toTime = '235959') {
 806     if ($relative) {
 807       list($term, $unit) = explode('.', $relative, 2);
 808       $dateRange = self::relativeToAbsolute($term, $unit);
 809       $from = substr($dateRange['from'], 0, 8);
 810       $to = substr($dateRange['to'], 0, 8);
 811       // @todo fix relativeToAbsolute & add tests
 812       // relativeToAbsolute returns 8 char date strings
 813       // or 14 char date + time strings.
 814       // We should use those. However, it turns out to be unreliable.
 815       // e.g. this.week does NOT return 235959 for 'from'
 816       // so our defaults are more reliable.
 817       // Currently relativeToAbsolute only supports 'whole' days so that is ok
 818     }
 819
 820     $from = self::processDate($from, $fromTime);
 821     $to = self::processDate($to, $toTime);
 822
 823     return array($from, $to);
 824   }
 825
 826   /**
 827    * Calculate Age in Years if greater than one year else in months.
 828    *
 829    * @param date $birthDate
 830    *   Birth Date.
 831    *
 832    * @return int
 833    *   array $results contains years or months
 834    */
 835   static public function calculateAge($birthDate) {
 836     $results = array();
 837     $formatedBirthDate = CRM_Utils_Date::customFormat($birthDate, '%Y-%m-%d');
 838
 839     $bDate = explode('-', $formatedBirthDate);
 840     $birthYear = $bDate[0];
 841     $birthMonth = $bDate[1];
 842     $birthDay = $bDate[2];
 843     $year_diff = date("Y") - $birthYear;
 844
 845     // don't calculate age CRM-3143
 846     if ($birthYear == '1902') {
 847       return $results;
 848     }
 849
 850     switch ($year_diff) {
 851       case 1:
 852         $month = (12 - $birthMonth) + date("m");
 853         if ($month < 12) {
 854           if (date("d") < $birthDay) {
 855             $month--;
 856           }
 857           $results['months'] = $month;
 858         }
 859         elseif ($month == 12 && (date("d") < $birthDay)) {
 860           $results['months'] = $month - 1;
 861         }
 862         else {
 863           $results['years'] = $year_diff;
 864         }
 865         break;
 866
 867       case 0:
 868         $month = date("m") - $birthMonth;
 869         $results['months'] = $month;
 870         break;
 871
 872       default:
 873         $results['years'] = $year_diff;
 874         if ((date("m") < $birthMonth) || (date("m") == $birthMonth) && (date("d") < $birthDay)) {
 875           $results['years']--;
 876         }
 877     }
 878
 879     return $results;
 880   }
 881
 882   /**
 883    * Calculate next payment date according to provided  unit & interval
 884    *
 885    * @param string $unit
 886    *   Frequency unit like year,month, week etc.
 887    *
 888    * @param int $interval
 889    *   Frequency interval.
 890    *
 891    * @param array $date
 892    *   Start date of pledge.
 893    *
 894    * @param bool $dontCareTime
 895    *
 896    * @return array
 897    *   contains new date with added interval
 898    */
 899   public static function intervalAdd($unit, $interval, $date, $dontCareTime = FALSE) {
 900     if (is_array($date)) {
 901       $hour = CRM_Utils_Array::value('H', $date);
 902       $minute = CRM_Utils_Array::value('i', $date);
 903       $second = CRM_Utils_Array::value('s', $date);
 904       $month = CRM_Utils_Array::value('M', $date);
 905       $day = CRM_Utils_Array::value('d', $date);
 906       $year = CRM_Utils_Array::value('Y', $date);
 907     }
 908     else {
 909       extract(date_parse($date));
 910     }
 911     $date = mktime($hour, $minute, $second, $month, $day, $year);
 912     switch ($unit) {
 913       case 'year':
 914         $date = mktime($hour, $minute, $second, $month, $day, $year + $interval);
 915         break;
 916
 917       case 'month':
 918         $date = mktime($hour, $minute, $second, $month + $interval, $day, $year);
 919         break;
 920
 921       case 'week':
 922         $interval = $interval * 7;
 923         $date = mktime($hour, $minute, $second, $month, $day + $interval, $year);
 924         break;
 925
 926       case 'day':
 927         $date = mktime($hour, $minute, $second, $month, $day + $interval, $year);
 928         break;
 929
 930       case 'second':
 931         $date = mktime($hour, $minute, $second + $interval, $month, $day, $year);
 932         break;
 933     }
 934
 935     $scheduleDate = explode("-", date("n-j-Y-H-i-s", $date));
 936
 937     $date = array();
 938     $date['M'] = $scheduleDate[0];
 939     $date['d'] = $scheduleDate[1];
 940     $date['Y'] = $scheduleDate[2];
 941     if ($dontCareTime == FALSE) {
 942       $date['H'] = $scheduleDate[3];
 943       $date['i'] = $scheduleDate[4];
 944       $date['s'] = $scheduleDate[5];
 945     }
 946     return $date;
 947   }
 948
 949   /**
 950    * Get the smarty view presentation mapping for the given format.
 951    *
 952    * Historically it was decided that where the view format is 'dd/mm/yy' or 'mm/dd/yy'
 953    * they should be rendered using a longer date format. This is likely as much to
 954    * do with the earlier date widget being unable to handle some formats as usablity.
 955    * However, we continue to respect this.
 956    *
 957    * @param $format
 958    *   Given format ( eg 'M Y', 'Y M' ).
 959    *
 960    * @return string|null
 961    *   Smarty translation of the date format. Null is also valid and is translated
 962    *   according to the available parts at the smarty layer.
 963    */
 964   public static function getDateFieldViewFormat($format) {
 965     $supportableFormats = array(
 966       'mm/dd' => '%B %E%f',
 967       'dd-mm' => '%E%f %B',
 968       'yy-mm' => '%Y %B',
 969       'M yy' => '%b %Y',
 970       'yy' => '%Y',
 971       'dd/mm/yy' => '%E%f %B %Y',
 972     );
 973
 974     return array_key_exists($format, $supportableFormats) ? $supportableFormats[$format] : self::pickBestSmartyFormat($format);
 975   }
 976
 977   /**
 978    * Pick the smarty format from settings that best matches the time string we have.
 979    *
 980    * For view purposes we historically use the setting that most closely matches the data
 981    * in the format from our settings, as opposed to the setting configured for the field.
 982    *
 983    * @param $format
 984    * @return mixed
 985    */
 986   public static function pickBestSmartyFormat($format) {
 987     if (stristr($format, 'h')) {
 988       return Civi::settings()->get('dateformatDatetime');
 989     }
 990     if (stristr($format, 'd') || stristr($format, 'j')) {
 991       return Civi::settings()->get('dateformatFull');
 992     }
 993     if (stristr($format, 'm')) {
 994       return Civi::settings()->get('dateformatPartial');
 995     }
 996     return Civi::settings()->get('dateformatYear');
 997   }
 998
 999   /**
1000    * Map date plugin and actual format that is used by PHP.
1001    *
1002    * @return array
1003    */
1004   public static function datePluginToPHPFormats() {
1005     $dateInputFormats = array(
1006       "mm/dd/yy" => 'm/d/Y',
1007       "dd/mm/yy" => 'd/m/Y',
1008       "yy-mm-dd" => 'Y-m-d',
1009       "dd-mm-yy" => 'd-m-Y',
1010       "dd.mm.yy" => 'd.m.Y',
1011       "M d" => 'M j',
1012       "M d, yy" => 'M j, Y',
1013       "d M yy" => 'j M Y',
1014       "MM d, yy" => 'F j, Y',
1015       "d MM yy" => 'j F Y',
1016       "DD, d MM yy" => 'l, j F Y',
1017       "mm/dd" => 'm/d',
1018       "dd-mm" => 'd-m',
1019       "yy-mm" => 'Y-m',
1020       "M yy" => 'M Y',
1021       "M Y" => 'M Y',
1022       "yy" => 'Y',
1023     );
1024     return $dateInputFormats;
1025   }
1026
1027   /**
1028    * Resolves the given relative time interval into finite time limits.
1029    *
1030    * @param string $relativeTerm
1031    *   Relative time frame: this, previous, previous_1.
1032    * @param int $unit
1033    *   Frequency unit like year, month, week etc.
1034    *
1035    * @return array
1036    *   start date and end date for the relative time frame
1037    */
1038   public static function relativeToAbsolute($relativeTerm, $unit) {
1039     $now = getdate();
1040     $from = $to = $dateRange = array();
1041     $from['H'] = $from['i'] = $from['s'] = 0;
1042     $relativeTermParts = explode('_', $relativeTerm);
1043     $relativeTermPrefix = $relativeTermParts[0];
1044     $relativeTermSuffix = isset($relativeTermParts[1]) ? $relativeTermParts[1] : '';
1045
1046     switch ($unit) {
1047       case 'year':
1048         switch ($relativeTerm) {
1049           case 'this':
1050             $from['d'] = $from['M'] = 1;
1051             $to['d'] = 31;
1052             $to['M'] = 12;
1053             $to['Y'] = $from['Y'] = $now['year'];
1054             break;
1055
1056           case 'previous':
1057             $from['M'] = $from['d'] = 1;
1058             $to['d'] = 31;
1059             $to['M'] = 12;
1060             $to['Y'] = $from['Y'] = $now['year'] - 1;
1061             break;
1062
1063           case 'previous_before':
1064             $from['M'] = $from['d'] = 1;
1065             $to['d'] = 31;
1066             $to['M'] = 12;
1067             $to['Y'] = $from['Y'] = $now['year'] - 2;
1068             break;
1069
1070           case 'previous_2':
1071             $from['M'] = $from['d'] = 1;
1072             $to['d'] = 31;
1073             $to['M'] = 12;
1074             $from['Y'] = $now['year'] - 2;
1075             $to['Y'] = $now['year'] - 1;
1076             break;
1077
1078           case 'earlier':
1079             $to['d'] = 31;
1080             $to['M'] = 12;
1081             $to['Y'] = $now['year'] - 1;
1082             unset($from);
1083             break;
1084
1085           case 'greater':
1086             $from['M'] = $from['d'] = 1;
1087             $from['Y'] = $now['year'];
1088             unset($to);
1089             break;
1090
1091           case 'greater_previous':
1092             $from['d'] = 31;
1093             $from['M'] = 12;
1094             $from['Y'] = $now['year'] - 1;
1095             unset($to);
1096             break;
1097
1098           case 'ending':
1099             $to['d'] = $now['mday'];
1100             $to['M'] = $now['mon'];
1101             $to['Y'] = $now['year'];
1102             $to['H'] = 23;
1103             $to['i'] = $to['s'] = 59;
1104             $from = self::intervalAdd('year', -1, $to);
1105             $from = self::intervalAdd('second', 1, $from);
1106             break;
1107
1108           case 'current':
1109             $from['M'] = $from['d'] = 1;
1110             $from['Y'] = $now['year'];
1111             $to['H'] = 23;
1112             $to['i'] = $to['s'] = 59;
1113             $to['d'] = $now['mday'];
1114             $to['M'] = $now['mon'];
1115             $to['Y'] = $now['year'];
1116             break;
1117
1118           case 'ending_2':
1119             $to['d'] = $now['mday'];
1120             $to['M'] = $now['mon'];
1121             $to['Y'] = $now['year'];
1122             $to['H'] = 23;
1123             $to['i'] = $to['s'] = 59;
1124             $from = self::intervalAdd('year', -2, $to);
1125             $from = self::intervalAdd('second', 1, $from);
1126             break;
1127
1128           case 'ending_3':
1129             $to['d'] = $now['mday'];
1130             $to['M'] = $now['mon'];
1131             $to['Y'] = $now['year'];
1132             $to['H'] = 23;
1133             $to['i'] = $to['s'] = 59;
1134             $from = self::intervalAdd('year', -3, $to);
1135             $from = self::intervalAdd('second', 1, $from);
1136             break;
1137
1138           case 'less':
1139             $to['d'] = 31;
1140             $to['M'] = 12;
1141             $to['Y'] = $now['year'];
1142             unset($from);
1143             break;
1144
1145           case 'next':
1146             $from['M'] = $from['d'] = 1;
1147             $to['d'] = 31;
1148             $to['M'] = 12;
1149             $to['Y'] = $from['Y'] = $now['year'] + 1;
1150             break;
1151
1152           case 'starting':
1153             $from['d'] = $now['mday'];
1154             $from['M'] = $now['mon'];
1155             $from['Y'] = $now['year'];
1156             $to['d'] = $now['mday'] - 1;
1157             $to['M'] = $now['mon'];
1158             $to['Y'] = $now['year'] + 1;
1159             break;
1160         }
1161         break;
1162
1163       case 'fiscal_year':
1164         $config = CRM_Core_Config::singleton();
1165         $from['d'] = $config->fiscalYearStart['d'];
1166         $from['M'] = $config->fiscalYearStart['M'];
1167         $fYear = self::calculateFiscalYear($from['d'], $from['M']);
1168         switch ($relativeTermPrefix) {
1169           case 'this':
1170             $from['Y'] = $fYear;
1171             $fiscalYear = mktime(0, 0, 0, $from['M'], $from['d'] - 1, $from['Y'] + 1);
1172             $fiscalEnd = explode('-', date("Y-m-d", $fiscalYear));
1173
1174             $to['d'] = $fiscalEnd['2'];
1175             $to['M'] = $fiscalEnd['1'];
1176             $to['Y'] = $fiscalEnd['0'];
1177             break;
1178
1179           case 'previous':
1180             if (!is_numeric($relativeTermSuffix)) {
1181               $from['Y'] = ($relativeTermSuffix === 'before') ? $fYear - 2 : $fYear - 1;
1182               $fiscalYear = mktime(0, 0, 0, $from['M'], $from['d'] - 1, $from['Y'] + 1);
1183               $fiscalEnd = explode('-', date("Y-m-d", $fiscalYear));
1184               $to['d'] = $fiscalEnd['2'];
1185               $to['M'] = $fiscalEnd['1'];
1186               $to['Y'] = $fiscalEnd['0'];
1187             }
1188             else {
1189               $from['Y'] = $fYear - $relativeTermSuffix;
1190               $fiscalYear = mktime(0, 0, 0, $from['M'], $from['d'] - 1, $from['Y'] + 1);
1191               $fiscalEnd = explode('-', date("Y-m-d", $fiscalYear));
1192               $to['d'] = $fiscalEnd['2'];
1193               $to['M'] = $fiscalEnd['1'];
1194               $to['Y'] = $fYear;
1195             }
1196             break;
1197
1198           case 'next':
1199             $from['Y'] = $fYear + 1;
1200             $fiscalYear = mktime(0, 0, 0, $from['M'], $from['d'] - 1, $from['Y'] + 1);
1201             $fiscalEnd = explode('-', date("Y-m-d", $fiscalYear));
1202             $to['d'] = $fiscalEnd['2'];
1203             $to['M'] = $fiscalEnd['1'];
1204             $to['Y'] = $fiscalEnd['0'];
1205             break;
1206         }
1207         break;
1208
1209       case 'quarter':
1210         switch ($relativeTerm) {
1211           case 'this':
1212
1213             $quarter = ceil($now['mon'] / 3);
1214             $from['d'] = 1;
1215             $from['M'] = (3 * $quarter) - 2;
1216             $to['M'] = 3 * $quarter;
1217             $to['Y'] = $from['Y'] = $now['year'];
1218             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $now['year']));
1219             break;
1220
1221           case 'previous':
1222             $difference = 1;
1223             $quarter = ceil($now['mon'] / 3);
1224             $quarter = $quarter - $difference;
1225             $subtractYear = 0;
1226             if ($quarter <= 0) {
1227               $subtractYear = 1;
1228               $quarter += 4;
1229             }
1230             $from['d'] = 1;
1231             $from['M'] = (3 * $quarter) - 2;
1232             $to['M'] = 3 * $quarter;
1233             $to['Y'] = $from['Y'] = $now['year'] - $subtractYear;
1234             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1235             break;
1236
1237           case 'previous_before':
1238             $difference = 2;
1239             $quarter = ceil($now['mon'] / 3);
1240             $quarter = $quarter - $difference;
1241             $subtractYear = 0;
1242             if ($quarter <= 0) {
1243               $subtractYear = 1;
1244               $quarter += 4;
1245             }
1246             $from['d'] = 1;
1247             $from['M'] = (3 * $quarter) - 2;
1248             $to['M'] = 3 * $quarter;
1249             $to['Y'] = $from['Y'] = $now['year'] - $subtractYear;
1250             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1251             break;
1252
1253           case 'previous_2':
1254             $difference = 2;
1255             $quarter = ceil($now['mon'] / 3);
1256             $current_quarter = $quarter;
1257             $quarter = $quarter - $difference;
1258             $subtractYear = 0;
1259             if ($quarter <= 0) {
1260               $subtractYear = 1;
1261               $quarter += 4;
1262             }
1263             $from['d'] = 1;
1264             $from['M'] = (3 * $quarter) - 2;
1265             switch ($current_quarter) {
1266               case 1:
1267                 $to['M'] = (4 * $quarter);
1268                 break;
1269
1270               case 2:
1271                 $to['M'] = (4 * $quarter) + 3;
1272                 break;
1273
1274               case 3:
1275                 $to['M'] = (4 * $quarter) + 2;
1276                 break;
1277
1278               case 4:
1279                 $to['M'] = (4 * $quarter) + 1;
1280                 break;
1281             }
1282             $to['Y'] = $from['Y'] = $now['year'] - $subtractYear;
1283             if ($to['M'] > 12) {
1284               $to['M'] = 3 * ($quarter - 3);
1285               $to['Y'] = $now['year'];
1286             }
1287             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1288             break;
1289
1290           case 'earlier':
1291             $quarter = ceil($now['mon'] / 3) - 1;
1292             $subtractYear = 0;
1293             if ($quarter <= 0) {
1294               $subtractYear = 1;
1295               $quarter += 4;
1296             }
1297             $to['M'] = 3 * $quarter;
1298             $to['Y'] = $from['Y'] = $now['year'] - $subtractYear;
1299             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1300             unset($from);
1301             break;
1302
1303           case 'greater':
1304             $quarter = ceil($now['mon'] / 3);
1305             $from['d'] = 1;
1306             $from['M'] = (3 * $quarter) - 2;
1307             $from['Y'] = $now['year'];
1308             unset($to);
1309             break;
1310
1311           case 'greater_previous':
1312             $quarter = ceil($now['mon'] / 3) - 1;
1313             $subtractYear = 0;
1314             if ($quarter <= 0) {
1315               $subtractYear = 1;
1316               $quarter += 4;
1317             }
1318             $from['M'] = 3 * $quarter;
1319             $from['Y'] = $from['Y'] = $now['year'] - $subtractYear;
1320             $from['d'] = date('t', mktime(0, 0, 0, $from['M'], 1, $from['Y']));
1321             unset($to);
1322             break;
1323
1324           case 'ending':
1325             $to['d'] = $now['mday'];
1326             $to['M'] = $now['mon'];
1327             $to['Y'] = $now['year'];
1328             $to['H'] = 23;
1329             $to['i'] = $to['s'] = 59;
1330             $from = self::intervalAdd('day', -90, $to);
1331             $from = self::intervalAdd('second', 1, $from);
1332             break;
1333
1334           case 'current':
1335             $quarter = ceil($now['mon'] / 3);
1336             $from['d'] = 1;
1337             $from['M'] = (3 * $quarter) - 2;
1338             $from['Y'] = $now['year'];
1339             $to['d'] = $now['mday'];
1340             $to['M'] = $now['mon'];
1341             $to['Y'] = $now['year'];
1342             $to['H'] = 23;
1343             $to['i'] = $to['s'] = 59;
1344             break;
1345
1346           case 'less':
1347             $quarter = ceil($now['mon'] / 3);
1348             $to['M'] = 3 * $quarter;
1349             $to['Y'] = $now['year'];
1350             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $now['year']));
1351             unset($from);
1352             break;
1353
1354           case 'next':
1355             $difference = -1;
1356             $subtractYear = 0;
1357             $quarter = ceil($now['mon'] / 3);
1358             $quarter = $quarter - $difference;
1359             // CRM-14550 QA Fix
1360             if ($quarter > 4) {
1361               $now['year'] = $now['year'] + 1;
1362               $quarter = 1;
1363             }
1364             if ($quarter <= 0) {
1365               $subtractYear = 1;
1366               $quarter += 4;
1367             }
1368             $from['d'] = 1;
1369             $from['M'] = (3 * $quarter) - 2;
1370             $to['M'] = 3 * $quarter;
1371             $to['Y'] = $from['Y'] = $now['year'] - $subtractYear;
1372             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1373             break;
1374
1375           case 'starting':
1376             $from['d'] = $now['mday'];
1377             $from['M'] = $now['mon'];
1378             $from['Y'] = $now['year'];
1379             $from['H'] = 00;
1380             $from['i'] = $to['s'] = 00;
1381             $to = self::intervalAdd('day', 90, $from);
1382             $to = self::intervalAdd('second', -1, $to);
1383             break;
1384         }
1385         break;
1386
1387       case 'month':
1388         switch ($relativeTerm) {
1389           case 'this':
1390             $from['d'] = 1;
1391             $to['d'] = date('t', mktime(0, 0, 0, $now['mon'], 1, $now['year']));
1392             $from['M'] = $to['M'] = $now['mon'];
1393             $from['Y'] = $to['Y'] = $now['year'];
1394             break;
1395
1396           case 'previous':
1397             $from['d'] = 1;
1398             if ($now['mon'] == 1) {
1399               $from['M'] = $to['M'] = 12;
1400               $from['Y'] = $to['Y'] = $now['year'] - 1;
1401             }
1402             else {
1403               $from['M'] = $to['M'] = $now['mon'] - 1;
1404               $from['Y'] = $to['Y'] = $now['year'];
1405             }
1406             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1407             break;
1408
1409           case 'previous_before':
1410             $from['d'] = 1;
1411             if ($now['mon'] < 3) {
1412               $from['M'] = $to['M'] = 10 + $now['mon'];
1413               $from['Y'] = $to['Y'] = $now['year'] - 1;
1414             }
1415             else {
1416               $from['M'] = $to['M'] = $now['mon'] - 2;
1417               $from['Y'] = $to['Y'] = $now['year'];
1418             }
1419             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1420             break;
1421
1422           case 'previous_2':
1423             $from['d'] = 1;
1424             if ($now['mon'] < 3) {
1425               $from['M'] = 10 + $now['mon'];
1426               $from['Y'] = $now['year'] - 1;
1427             }
1428             else {
1429               $from['M'] = $now['mon'] - 2;
1430               $from['Y'] = $now['year'];
1431             }
1432
1433             if ($now['mon'] == 1) {
1434               $to['M'] = 12;
1435               $to['Y'] = $now['year'] - 1;
1436             }
1437             else {
1438               $to['M'] = $now['mon'] - 1;
1439               $to['Y'] = $now['year'];
1440             }
1441
1442             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1443             break;
1444
1445           case 'earlier':
1446             // before end of past month
1447             if ($now['mon'] == 1) {
1448               $to['M'] = 12;
1449               $to['Y'] = $now['year'] - 1;
1450             }
1451             else {
1452               $to['M'] = $now['mon'] - 1;
1453               $to['Y'] = $now['year'];
1454             }
1455
1456             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1457             unset($from);
1458             break;
1459
1460           case 'greater':
1461             $from['d'] = 1;
1462             $from['M'] = $now['mon'];;
1463             $from['Y'] = $now['year'];
1464             unset($to);
1465             break;
1466
1467           case 'greater_previous':
1468             // from end of past month
1469             if ($now['mon'] == 1) {
1470               $from['M'] = 12;
1471               $from['Y'] = $now['year'] - 1;
1472             }
1473             else {
1474               $from['M'] = $now['mon'] - 1;
1475               $from['Y'] = $now['year'];
1476             }
1477
1478             $from['d'] = date('t', mktime(0, 0, 0, $from['M'], 1, $from['Y']));
1479             unset($to);
1480             break;
1481
1482           case 'ending_2':
1483             $to['d'] = $now['mday'];
1484             $to['M'] = $now['mon'];
1485             $to['Y'] = $now['year'];
1486             $to['H'] = 23;
1487             $to['i'] = $to['s'] = 59;
1488             $from = self::intervalAdd('day', -60, $to);
1489             $from = self::intervalAdd('second', 1, $from);
1490             break;
1491
1492           case 'ending':
1493             $to['d'] = $now['mday'];
1494             $to['M'] = $now['mon'];
1495             $to['Y'] = $now['year'];
1496             $to['H'] = 23;
1497             $to['i'] = $to['s'] = 59;
1498             $from = self::intervalAdd('day', -30, $to);
1499             $from = self::intervalAdd('second', 1, $from);
1500             break;
1501
1502           case 'current':
1503             $from['d'] = 1;
1504             $from['M'] = $now['mon'];;
1505             $from['Y'] = $now['year'];
1506             $to['d'] = $now['mday'];
1507             $to['M'] = $now['mon'];
1508             $to['Y'] = $now['year'];
1509             $to['H'] = 23;
1510             $to['i'] = $to['s'] = 59;
1511             break;
1512
1513           case 'less':
1514             // CRM-14550 QA Fix
1515             $to['Y'] = $now['year'];
1516             $to['M'] = $now['mon'];
1517             $to['d'] = date('t', mktime(0, 0, 0, $now['mon'], 1, $now['year']));
1518             unset($from);
1519             break;
1520
1521           case 'next':
1522             $from['d'] = 1;
1523             if ($now['mon'] == 12) {
1524               $from['M'] = $to['M'] = 1;
1525               $from['Y'] = $to['Y'] = $now['year'] + 1;
1526             }
1527             else {
1528               $from['M'] = $to['M'] = $now['mon'] + 1;
1529               $from['Y'] = $to['Y'] = $now['year'];
1530             }
1531             $to['d'] = date('t', mktime(0, 0, 0, $to['M'], 1, $to['Y']));
1532             break;
1533
1534           case 'starting':
1535             $from['d'] = $now['mday'];
1536             $from['M'] = $now['mon'];
1537             $from['Y'] = $now['year'];
1538             $from['H'] = 00;
1539             $from['i'] = $to['s'] = 00;
1540             $to = self::intervalAdd('day', 30, $from);
1541             $to = self::intervalAdd('second', -1, $to);
1542             break;
1543
1544           case 'starting_2':
1545             $from['d'] = $now['mday'];
1546             $from['M'] = $now['mon'];
1547             $from['Y'] = $now['year'];
1548             $from['H'] = 00;
1549             $from['i'] = $to['s'] = 00;
1550             $to = self::intervalAdd('day', 60, $from);
1551             $to = self::intervalAdd('second', -1, $to);
1552             break;
1553         }
1554         break;
1555
1556       case 'week':
1557         $weekFirst = Civi::settings()->get('weekBegins');
1558         $thisDay = $now['wday'];
1559         if ($weekFirst > $thisDay) {
1560           $diffDay = $thisDay - $weekFirst + 7;
1561         }
1562         else {
1563           $diffDay = $thisDay - $weekFirst;
1564         }
1565         switch ($relativeTerm) {
1566           case 'this':
1567             $from['d'] = $now['mday'];
1568             $from['M'] = $now['mon'];
1569             $from['Y'] = $now['year'];
1570             $from = self::intervalAdd('day', -1 * ($diffDay), $from);
1571             $to = self::intervalAdd('day', 6, $from);
1572             break;
1573
1574           case 'previous':
1575             $from['d'] = $now['mday'];
1576             $from['M'] = $now['mon'];
1577             $from['Y'] = $now['year'];
1578             $from = self::intervalAdd('day', -1 * ($diffDay) - 7, $from);
1579             $to = self::intervalAdd('day', 6, $from);
1580             break;
1581
1582           case 'previous_before':
1583             $from['d'] = $now['mday'];
1584             $from['M'] = $now['mon'];
1585             $from['Y'] = $now['year'];
1586             $from = self::intervalAdd('day', -1 * ($diffDay) - 14, $from);
1587             $to = self::intervalAdd('day', 6, $from);
1588             break;
1589
1590           case 'previous_2':
1591             $from['d'] = $now['mday'];
1592             $from['M'] = $now['mon'];
1593             $from['Y'] = $now['year'];
1594             $from = self::intervalAdd('day', -1 * ($diffDay) - 14, $from);
1595             $to = self::intervalAdd('day', 13, $from);
1596             break;
1597
1598           case 'earlier':
1599             $to['d'] = $now['mday'];
1600             $to['M'] = $now['mon'];
1601             $to['Y'] = $now['year'];
1602             $to = self::intervalAdd('day', -1 * ($diffDay) - 1, $to);
1603             unset($from);
1604             break;
1605
1606           case 'greater':
1607             $from['d'] = $now['mday'];
1608             $from['M'] = $now['mon'];
1609             $from['Y'] = $now['year'];
1610             $from = self::intervalAdd('day', -1 * ($diffDay), $from);
1611             unset($to);
1612             break;
1613
1614           case 'greater_previous':
1615             $from['d'] = $now['mday'];
1616             $from['M'] = $now['mon'];
1617             $from['Y'] = $now['year'];
1618             $from = self::intervalAdd('day', -1 * ($diffDay) - 1, $from);
1619             unset($to);
1620             break;
1621
1622           case 'ending':
1623             $to['d'] = $now['mday'];
1624             $to['M'] = $now['mon'];
1625             $to['Y'] = $now['year'];
1626             $to['H'] = 23;
1627             $to['i'] = $to['s'] = 59;
1628             $from = self::intervalAdd('day', -7, $to);
1629             $from = self::intervalAdd('second', 1, $from);
1630             break;
1631
1632           case 'current':
1633             $from['d'] = $now['mday'];
1634             $from['M'] = $now['mon'];
1635             $from['Y'] = $now['year'];
1636             $from = self::intervalAdd('day', -1 * ($diffDay), $from);
1637             $to['d'] = $now['mday'];
1638             $to['M'] = $now['mon'];
1639             $to['Y'] = $now['year'];
1640             $to['H'] = 23;
1641             $to['i'] = $to['s'] = 59;
1642             break;
1643
1644           case 'less':
1645             $to['d'] = $now['mday'];
1646             $to['M'] = $now['mon'];
1647             $to['Y'] = $now['year'];
1648             // CRM-14550 QA Fix
1649             $to = self::intervalAdd('day', -1 * ($diffDay) + 6, $to);
1650             unset($from);
1651             break;
1652
1653           case 'next':
1654             $from['d'] = $now['mday'];
1655             $from['M'] = $now['mon'];
1656             $from['Y'] = $now['year'];
1657             $from = self::intervalAdd('day', -1 * ($diffDay) + 7, $from);
1658             $to = self::intervalAdd('day', 6, $from);
1659             break;
1660
1661           case 'starting':
1662             $from['d'] = $now['mday'];
1663             $from['M'] = $now['mon'];
1664             $from['Y'] = $now['year'];
1665             $from['H'] = 00;
1666             $from['i'] = $to['s'] = 00;
1667             $to = self::intervalAdd('day', 7, $from);
1668             $to = self::intervalAdd('second', -1, $to);
1669             break;
1670         }
1671         break;
1672
1673       case 'day':
1674         switch ($relativeTerm) {
1675           case 'this':
1676             $from['d'] = $to['d'] = $now['mday'];
1677             $from['M'] = $to['M'] = $now['mon'];
1678             $from['Y'] = $to['Y'] = $now['year'];
1679             break;
1680
1681           case 'previous':
1682             $from['d'] = $now['mday'];
1683             $from['M'] = $now['mon'];
1684             $from['Y'] = $now['year'];
1685             $from = self::intervalAdd('day', -1, $from);
1686             $to['d'] = $from['d'];
1687             $to['M'] = $from['M'];
1688             $to['Y'] = $from['Y'];
1689             break;
1690
1691           case 'previous_before':
1692             $from['d'] = $now['mday'];
1693             $from['M'] = $now['mon'];
1694             $from['Y'] = $now['year'];
1695             $from = self::intervalAdd('day', -2, $from);
1696             $to['d'] = $from['d'];
1697             $to['M'] = $from['M'];
1698             $to['Y'] = $from['Y'];
1699             break;
1700
1701           case 'previous_2':
1702             $from['d'] = $to['d'] = $now['mday'];
1703             $from['M'] = $to['M'] = $now['mon'];
1704             $from['Y'] = $to['Y'] = $now['year'];
1705             $from = self::intervalAdd('day', -2, $from);
1706             $to = self::intervalAdd('day', -1, $to);
1707             break;
1708
1709           case 'earlier':
1710             $to['d'] = $now['mday'];
1711             $to['M'] = $now['mon'];
1712             $to['Y'] = $now['year'];
1713             unset($from);
1714             break;
1715
1716           case 'greater':
1717             $from['d'] = $now['mday'];
1718             $from['M'] = $now['mon'];;
1719             $from['Y'] = $now['year'];
1720             unset($to);
1721             break;
1722
1723           case 'starting':
1724             $to['d'] = $now['mday'];
1725             $to['M'] = $now['mon'];
1726             $to['Y'] = $now['year'];
1727             $to = self::intervalAdd('day', 1, $to);
1728             $from['d'] = $to['d'];
1729             $from['M'] = $to['M'];
1730             $from['Y'] = $to['Y'];
1731             break;
1732
1733         }
1734         break;
1735     }
1736
1737     foreach (array(
1738                'from',
1739                'to',
1740              ) as $item) {
1741       if (!empty($$item)) {
1742         $dateRange[$item] = self::format($$item);
1743       }
1744       else {
1745         $dateRange[$item] = NULL;
1746       }
1747     }
1748     return $dateRange;
1749   }
1750
1751   /**
1752    * Calculate current fiscal year based on the fiscal month and day.
1753    *
1754    * @param int $fyDate
1755    *   Fiscal start date.
1756    *
1757    * @param int $fyMonth
1758    *   Fiscal Start Month.
1759    *
1760    * @return int
1761    *   $fy       Current Fiscal Year
1762    */
1763   public static function calculateFiscalYear($fyDate, $fyMonth) {
1764     $date = date("Y-m-d");
1765     $currentYear = date("Y");
1766
1767     // recalculate the date because month 4::04 make the difference
1768     $fiscalYear = explode('-', date("Y-m-d", mktime(0, 0, 0, $fyMonth, $fyDate, $currentYear)));
1769     $fyDate = $fiscalYear[2];
1770     $fyMonth = $fiscalYear[1];
1771     $fyStartDate = date("Y-m-d", mktime(0, 0, 0, $fyMonth, $fyDate, $currentYear));
1772
1773     if ($fyStartDate > $date) {
1774       $fy = intval(intval($currentYear) - 1);
1775     }
1776     else {
1777       $fy = intval($currentYear);
1778     }
1779     return $fy;
1780   }
1781
1782   /**
1783    * Function to process date, convert to mysql format
1784    *
1785    * @param string $date
1786    *   Date string.
1787    * @param string $time
1788    *   Time string.
1789    * @param bool|string $returnNullString 'null' needs to be returned
1790    *                so that db oject will set null in db
1791    * @param string $format
1792    *   Expected return date format.( default is mysql ).
1793    *
1794    * @return string
1795    *   date format that is excepted by mysql
1796    */
1797   public static function processDate($date, $time = NULL, $returnNullString = FALSE, $format = 'YmdHis') {
1798     $mysqlDate = NULL;
1799
1800     if ($returnNullString) {
1801       $mysqlDate = 'null';
1802     }
1803
1804     if (trim($date)) {
1805       $mysqlDate = date($format, strtotime($date . ' ' . $time));
1806     }
1807
1808     return $mysqlDate;
1809   }
1810
1811   /**
1812    * Add the metadata about a date field to the field.
1813    *
1814    * This metadata will work with the call $form->add('datepicker', ...
1815    *
1816    * @param array $fieldMetaData
1817    * @param array $field
1818    *
1819    * @return array
1820    */
1821   public static function addDateMetadataToField($fieldMetaData, $field) {
1822     if (isset($fieldMetaData['html'])) {
1823       $field['html_type'] = $fieldMetaData['html']['type'];
1824       if ($field['html_type'] === 'Select Date') {
1825         if (!isset($field['date_format'])) {
1826           $dateAttributes = CRM_Core_SelectValues::date($fieldMetaData['html']['formatType'], NULL, NULL, NULL, 'Input');
1827           $field['start_date_years'] = $dateAttributes['minYear'];
1828           $field['end_date_years'] = $dateAttributes['maxYear'];
1829           $field['date_format'] = $dateAttributes['format'];
1830           $field['is_datetime_field'] = TRUE;
1831           $field['time_format'] = $dateAttributes['time'];
1832           $field['smarty_view_format'] = $dateAttributes['smarty_view_format'];
1833         }
1834         $field['datepicker']['extra'] = self::getDatePickerExtra($field);
1835         $field['datepicker']['attributes'] = self::getDatePickerAttributes($field);
1836       }
1837     }
1838     return $field;
1839   }
1840
1841
1842   /**
1843    * Get the fields required for the 'extra' parameter when adding a datepicker.
1844    *
1845    * @param array $field
1846    *
1847    * @return array
1848    */
1849   public static function getDatePickerExtra($field) {
1850     $extra = array();
1851     if (isset($field['date_format'])) {
1852       $extra['date'] = $field['date_format'];
1853       $extra['time'] = $field['time_format'];
1854     }
1855     $thisYear = date('Y');
1856     if (isset($field['start_date_years'])) {
1857       $extra['minDate'] = date('Y-m-d', strtotime('-' . ($thisYear - $field['start_date_years']) . ' years'));
1858     }
1859     if (isset($field['end_date_years'])) {
1860       $extra['maxDate'] = date('Y-m-d', strtotime('-' . ($thisYear - $field['end_date_years']) . ' years'));
1861     }
1862     return $extra;
1863   }
1864
1865   /**
1866    * Get the attributes parameters required for datepicker.
1867    *
1868    * @param array $field
1869    *   Field metadata
1870    *
1871    * @return array
1872    *   Array ready to pass to $this->addForm('datepicker' as attributes.
1873    */
1874   public static function getDatePickerAttributes(&$field) {
1875     $attributes = array();
1876     $dateAttributes = array(
1877       'start_date_years' => 'minYear',
1878       'end_date_years' => 'maxYear',
1879       'date_format' => 'format',
1880     );
1881     foreach ($dateAttributes as $dateAttribute => $mapTo) {
1882       if (isset($field[$dateAttribute])) {
1883         $attributes[$mapTo] = $field[$dateAttribute];
1884       }
1885     }
1886     return $attributes;
1887   }
1888
1889   /**
1890    * Function to convert mysql to date plugin format.
1891    *
1892    * @param string $mysqlDate
1893    *   Date string.
1894    *
1895    * @param null $formatType
1896    * @param null $format
1897    * @param null $timeFormat
1898    *
1899    * @return array
1900    *   and time
1901    */
1902   public static function setDateDefaults($mysqlDate = NULL, $formatType = NULL, $format = NULL, $timeFormat = NULL) {
1903     // if date is not passed assume it as today
1904     if (!$mysqlDate) {
1905       $mysqlDate = date('Y-m-d G:i:s');
1906     }
1907
1908     $config = CRM_Core_Config::singleton();
1909     if ($formatType) {
1910       // get actual format
1911       $params = array('name' => $formatType);
1912       $values = array();
1913       CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values);
1914
1915       if ($values['date_format']) {
1916         $format = $values['date_format'];
1917       }
1918
1919       if (isset($values['time_format'])) {
1920         $timeFormat = $values['time_format'];
1921       }
1922     }
1923
1924     // now we set display date using js, hence we should always setdefault
1925     // 'm/d/Y' format. So that submitted value is alwats mm/dd/YY format
1926     // note that for date display we dynamically create text field
1927     /*
1928     if ( !$format ) {
1929     $format = $config->dateInputFormat;
1930     }
1931
1932     // get actual format
1933     $actualPHPFormats = CRM_Core_SelectValues::datePluginToPHPFormats( );
1934     $dateFormat       = CRM_Utils_Array::value( $format, $actualPHPFormats );
1935      */
1936
1937     $dateFormat = 'm/d/Y';
1938     $date = date($dateFormat, strtotime($mysqlDate));
1939
1940     if (!$timeFormat) {
1941       $timeFormat = $config->timeInputFormat;
1942     }
1943
1944     $actualTimeFormat = "g:iA";
1945     $appendZeroLength = 7;
1946     if ($timeFormat > 1) {
1947       $actualTimeFormat = "G:i";
1948       $appendZeroLength = 5;
1949     }
1950
1951     $time = date($actualTimeFormat, strtotime($mysqlDate));
1952
1953     // need to append zero for hours < 10
1954     if (strlen($time) < $appendZeroLength) {
1955       $time = '0' . $time;
1956     }
1957
1958     return array($date, $time);
1959   }
1960
1961   /**
1962    * Function get date format.
1963    *
1964    * @param string $formatType
1965    *   Date name e.g. birth.
1966    *
1967    * @return string
1968    */
1969   public static function getDateFormat($formatType = NULL) {
1970     $format = NULL;
1971     if ($formatType) {
1972       $format = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_PreferencesDate',
1973         $formatType, 'date_format', 'name'
1974       );
1975     }
1976
1977     if (!$format) {
1978       $config = CRM_Core_Config::singleton();
1979       $format = $config->dateInputFormat;
1980     }
1981     return $format;
1982   }
1983
1984   /**
1985    * @param $date
1986    * @param $dateType
1987    *
1988    * @return null|string
1989    */
1990   public static function formatDate($date, $dateType) {
1991     $formattedDate = NULL;
1992     if (empty($date)) {
1993       return $formattedDate;
1994     }
1995
1996     // 1. first convert date to default format.
1997     // 2. append time to default formatted date (might be removed during format)
1998     // 3. validate date / date time.
1999     // 4. If date and time then convert to default date time format.
2000
2001     $dateKey = 'date';
2002     $dateParams = array($dateKey => $date);
2003
2004     if (CRM_Utils_Date::convertToDefaultDate($dateParams, $dateType, $dateKey)) {
2005       $dateVal = $dateParams[$dateKey];
2006       $ruleName = 'date';
2007       if ($dateType == 1) {
2008         $matches = array();
2009         if (preg_match("/(\s(([01]\d)|[2][0-3]):([0-5]\d))$/", $date, $matches)) {
2010           $ruleName = 'dateTime';
2011           if (strpos($date, '-') !== FALSE) {
2012             $dateVal .= array_shift($matches);
2013           }
2014         }
2015       }
2016
2017       // validate date.
2018       $valid = CRM_Utils_Rule::$ruleName($dateVal);
2019
2020       if ($valid) {
2021         // format date and time to default.
2022         if ($ruleName == 'dateTime') {
2023           $dateVal = CRM_Utils_Date::customFormat(preg_replace("/(:|\s)?/", "", $dateVal), '%Y%m%d%H%i');
2024           // hack to add seconds
2025           $dateVal .= '00';
2026         }
2027         $formattedDate = $dateVal;
2028       }
2029     }
2030
2031     return $formattedDate;
2032   }
2033
2034   /**
2035    * Function to return days of the month.
2036    *
2037    * @return array
2038    */
2039   public static function getCalendarDayOfMonth() {
2040     $month = array();
2041     for ($i = 1; $i <= 31; $i++) {
2042       $month[$i] = $i;
2043       if ($i == 31) {
2044         $month[$i] = $i . ' / Last day of month';
2045       }
2046     }
2047     return $month;
2048   }
2049
2050 }