include/SugarFields/Fields/Datetime/SugarFieldDatetime.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37 require_once('include/SugarFields/Fields/Base/SugarFieldBase.php');
  38
  39 class SugarFieldDatetime extends SugarFieldBase {
  40
  41     function getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
  42
  43         // Create Smarty variables for the Calendar picker widget
  44         if(!isset($displayParams['showMinutesDropdown'])) {
  45            $displayParams['showMinutesDropdown'] = false;
  46         }
  47
  48         if(!isset($displayParams['showHoursDropdown'])) {
  49            $displayParams['showHoursDropdown'] = false;
  50         }
  51
  52         if(!isset($displayParams['showNoneCheckbox'])) {
  53            $displayParams['showNoneCheckbox'] = false;
  54         }
  55
  56         if(!isset($displayParams['showFormats'])) {
  57            $displayParams['showFormats'] = false;
  58         }
  59
  60         if(!isset($displayParams['hiddeCalendar'])) {
  61            $displayParams['hiddeCalendar'] = false;
  62         }
  63
  64         // jpereira@dri - #Bug49552 - Datetime field unable to follow parent class methods
  65         //jchi , bug #24557 , 10/31/2008
  66         if(isset($vardef['name']) && ($vardef['name'] == 'date_entered' || $vardef['name'] == 'date_modified')){
  67             return $this->getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
  68         }
  69         //end
  70         return parent::getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
  71         // ~ jpereira@dri - #Bug49552 - Datetime field unable to follow parent class methods
  72     }
  73
  74     function getImportViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex)
  75     {
  76         $displayParams['showMinutesDropdown'] = false;
  77         $displayParams['showHoursDropdown'] = false;
  78         $displayParams['showNoneCheckbox'] = false;
  79         $displayParams['showFormats'] = true;
  80         $displayParams['hiddeCalendar'] = false;
  81
  82         $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
  83         return $this->fetch($this->findTemplate('EditView'));
  84     }
  85
  86
  87     function getSearchViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
  88         if($this->isRangeSearchView($vardef)) {
  89            $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
  90            $id = isset($displayParams['idName']) ? $displayParams['idName'] : $vardef['name'];
  91            $this->ss->assign('original_id', "{$id}");
  92            $this->ss->assign('id_range', "range_{$id}");
  93            $this->ss->assign('id_range_start', "start_range_{$id}");
  94            $this->ss->assign('id_range_end', "end_range_{$id}");
  95            $this->ss->assign('id_range_choice', "{$id}_range_choice");
  96            if(file_exists('custom/include/SugarFields/Fields/Datetimecombo/RangeSearchForm.tpl'))
  97            {
  98               return $this->fetch('custom/include/SugarFields/Fields/Datetimecombo/RangeSearchForm.tpl');
  99            }
 100            return $this->fetch('include/SugarFields/Fields/Datetimecombo/RangeSearchForm.tpl');
 101         }
 102         return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'EditView');
 103     }
 104
 105     public function getEmailTemplateValue($inputField, $vardef, $context = null){
 106         global $timedate;
 107         // This does not return a smarty section, instead it returns a direct value
 108         if(isset($context['notify_user'])) {
 109             $user = $context['notify_user'];
 110         } else {
 111             $user = $GLOBALS['current_user'];
 112         }
 113         if($vardef['type'] == 'date') {
 114             if(!$timedate->check_matching_format($inputField, TimeDate::DB_DATE_FORMAT)) {
 115                 return $inputField;
 116             }
 117             // convert without TZ
 118             return $timedate->to_display($inputField, $timedate->get_db_date_format(),  $timedate->get_date_format($user));
 119         } else {
 120             if(!$timedate->check_matching_format($inputField, TimeDate::DB_DATETIME_FORMAT)) {
 121                 return $inputField;
 122             }
 123             return $timedate->to_display_date_time($inputField, true, true, $user);
 124         }
 125     }
 126
 127     public function save($bean, $inputData, $field, $def, $prefix = '') {
 128         global $timedate;
 129         if ( !isset($inputData[$prefix.$field]) ) {
 130             return;
 131         }
 132
 133         $offset = strlen(trim($inputData[$prefix.$field])) < 11 ? false : true;
 134         if ($timedate->check_matching_format($inputData[$prefix.$field], TimeDate::DB_DATE_FORMAT)) {
 135             $bean->$field = $inputData[$prefix.$field];
 136         } else {
 137             $bean->$field = $timedate->to_db_date($inputData[$prefix.$field], $offset);
 138         }
 139     }
 140
 141     /**
 142      * @see SugarFieldBase::importSanitize()
 143      */
 144     public function importSanitize(
 145         $value,
 146         $vardef,
 147         $focus,
 148         ImportFieldSanitize $settings
 149         )
 150     {
 151         global $timedate;
 152
 153         $format = $timedate->merge_date_time($settings->dateformat, $settings->timeformat);
 154
 155         if ( !$timedate->check_matching_format($value, $format) ) {
 156             $parts = $timedate->split_date_time($value);
 157             if(empty($parts[0])) {
 158                $datepart = $timedate->getNow()->format($settings->dateformat);
 159             }
 160             else {
 161                $datepart = $parts[0];
 162             }
 163             if(empty($parts[1])) {
 164                 $timepart = $timedate->fromTimestamp(0)->format($settings->timeformat);
 165             } else {
 166                 $timepart = $parts[1];
 167                 // see if we can get by stripping the seconds
 168                 if(strpos($settings->timeformat, 's') === false) {
 169                     $sep = $timedate->timeSeparatorFormat($settings->timeformat);
 170                     // We are assuming here seconds are the last component, which
 171                     // is kind of reasonable - no sane time format puts seconds first
 172                     $timeparts = explode($sep, $timepart);
 173                     if(!empty($timeparts[2])) {
 174                         $timepart = join($sep, array($timeparts[0], $timeparts[1]));
 175                     }
 176                 }
 177             }
 178
 179             $value = $timedate->merge_date_time($datepart, $timepart);
 180             if ( !$timedate->check_matching_format($value, $format) ) {
 181                 return false;
 182             }
 183         }
 184
 185         try {
 186             $date = SugarDateTime::createFromFormat($format, $value, new DateTimeZone($settings->timezone));
 187         } catch(Exception $e) {
 188             return false;
 189         }
 190         return $date->asDb();
 191     }
 192
 193
 194     function getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
 195         global $timedate,$current_user;
 196
 197         //check to see if the date is in the proper format
 198         $user_dateFormat = $timedate->get_date_format();
 199         if(!empty($vardef['value']) && !$timedate->check_matching_format( $vardef['value'],$user_dateFormat)){
 200
 201             //date is not in proper user format, so get the SugarDateTiemObject and inject the vardef with a new element
 202             $sdt = $timedate->fromString($vardef['value'],$current_user);
 203
 204             if (!empty($sdt)) {
 205                 //the new 'date_formatted_value' array element will be used in include/SugarFields/Fields/Datetime/DetailView.tpl if it exists
 206                 $vardef['date_formatted_value'] = $timedate->asUserDate($sdt,$current_user);
 207             }
 208         }
 209
 210         return $this->getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex, 'DetailView');
 211     }
 212 }