CRM/Core/Smarty/plugins/modifier.crmDate.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Convert the date string "YYYY-MM-DD" to "MM<long> DD, YYYY".
  38  *
  39  * @param string $dateString date which needs to converted to human readable format
  40  *
  41  * @param null $dateFormat
  42  * @param bool $onlyTime
  43  *
  44  * @return string human readable date format | invalid date message
  45  * @access public
  46  */
  47 function smarty_modifier_crmDate($dateString, $dateFormat = NULL, $onlyTime = FALSE) {
  48   if ($dateString) {
  49     // this check needs to be type sensitive
  50     // CRM-3689, CRM-2441
  51     if ($dateFormat === 0) {
  52       $dateFormat = NULL;
  53     }
  54     if ($onlyTime) {
  55       $config = CRM_Core_Config::singleton();
  56       $dateFormat = $config->dateformatTime;
  57     }
  58
  59     return CRM_Utils_Date::customFormat($dateString, $dateFormat);
  60   }
  61   return '';
  62 }
  63