include/SugarFields/Fields/Address/SugarFieldAddress.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39
  40 /**
  41  * SugarFieldAddress.php
  42  * SugarFieldAddress translates and displays fields from a vardef definition into different formats
  43  * for EditViews and DetailViews.  A sample invocation from a Meta-Data file is as follows:
  44  *
  45  *  array (
  46  *         'name' => 'primary_address_street',
  47  *         'type' => 'address',
  48  *         'displayParams'=>array('key'=>'primary'),
  49  *  ),
  50  *
  51  * Where name is set to the field for ACL verification, type is set to 'address'
  52  * to override the default field type and the displayParams array includes the key
  53  * for the address field.  Assumptions are made that the vardefs.php contains address
  54  * elements with the corresponding names. There is the optional displayParam index
  55  * 'copy' that accepts as value the key of the other address fields.  In our
  56  * example we may enable copying from the primary address fields with:
  57  *
  58  *  array (
  59  *         'name' => 'altaddress_street',
  60  *         'type' => 'address',
  61  *         'displayParams'=>array('key'=>'alt', 'copy'=>'primary'),
  62  *  ),
  63  *
  64  */
  65 require_once('include/SugarFields/Fields/Base/SugarFieldBase.php');
  66 class SugarFieldAddress extends SugarFieldBase {
  67
  68     function getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
  69         $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
  70         global $app_strings;
  71         if(!isset($displayParams['key'])) {
  72            $GLOBALS['log']->debug($app_strings['ERR_ADDRESS_KEY_NOT_SPECIFIED']);
  73            $this->ss->trigger_error($app_strings['ERR_ADDRESS_KEY_NOT_SPECIFIED']);
  74            return;
  75         }
  76
  77         //Allow for overrides.  You can specify a Smarty template file location in the language file.
  78         if(isset($app_strings['SMARTY_ADDRESS_DETAILVIEW'])) {
  79            $tplCode = $app_strings['SMARTY_ADDRESS_DETAILVIEW'];
  80            return $this->fetch($tplCode);
  81         }
  82
  83         return $this->fetch($this->findTemplate('DetailView'));
  84     }
  85
  86     function getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
  87         $this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
  88         global $app_strings;
  89         if(!isset($displayParams['key'])) {
  90            $GLOBALS['log']->debug($app_strings['ERR_ADDRESS_KEY_NOT_SPECIFIED']);
  91            $this->ss->trigger_error($app_strings['ERR_ADDRESS_KEY_NOT_SPECIFIED']);
  92            return;
  93         }
  94
  95         //Allow for overrides.  You can specify a Smarty template file location in the language file.
  96         if(isset($app_strings['SMARTY_ADDRESS_EDITVIEW'])) {
  97            $tplCode = $app_strings['SMARTY_ADDRESS_EDITVIEW'];
  98            return $this->fetch($tplCode);
  99         }
 100
 101         return $this->fetch($this->findTemplate('EditView'));
 102     }
 103
 104 }
 105 ?>