include/Smarty/plugins/function.sugar_getlink.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 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
  38 /**
  39  * Smarty {sugar_getlink} function plugin
  40  *
  41  * Type:     function
  42  * Name:     sugar_getlink
  43  * Purpose:  Returns HTML link <a> with embedded image or normal text
  44  *
  45  * @param array
  46  * @param Smarty
  47  */
  48
  49 function smarty_function_sugar_getlink($params, &$smarty) {
  50
  51         // error checking for required parameters
  52         if(!isset($params['url']))
  53                 $smarty->trigger_error($GLOBALS['app_strings']['ERR_MISSING_REQUIRED_FIELDS'] . 'url');
  54         if(!isset($params['title']))
  55                 $smarty->trigger_error($GLOBALS['app_strings']['ERR_MISSING_REQUIRED_FIELDS'] . 'title');
  56
  57         // set defaults
  58         if(!isset($params['attr']))
  59                 $params['attr'] = '';
  60         if(!isset($params['img_name']))
  61                 $params['img_name'] = '';
  62         if(!isset($params['img_attr']))
  63                 $params['img_attr'] = '';
  64         if(!isset($params['img_width']))
  65                 $params['img_width'] = null;
  66         if(!isset($params['img_height']))
  67                 $params['height'] = null;
  68         if(!isset($params['img_placement']))
  69                 $params['img_placement'] = 'imageonly';
  70         if(!isset($params['img_alt']))
  71                 $params['img_alt'] = '';
  72
  73         return SugarThemeRegistry::current()->getLink($params['url'], $params['title'], $params['attr'], $params['img_name'],
  74                 $params['img_attr'], $params['img_width'], $params['img_height'], $params['img_alt'], $params['img_placement']);
  75 }
  76 ?>