include/generic/SugarWidgets/SugarWidget.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-2011 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 //TODO move me out of generic
  40
  41
  42
  43 /**
  44  * Generic Sugar widget
  45  * @api
  46  */
  47 class SugarWidget
  48 {
  49         var $layout_manager = null;
  50         var $widget_id;
  51
  52         function SugarWidget(&$layout_manager)
  53         {
  54                 $this->layout_manager = $layout_manager;
  55         }
  56         function display(&$layout_def)
  57         {
  58                 return 'display class undefined';
  59         }
  60
  61         /**
  62          * getSubpanelWidgetId
  63          * This is a utility function to return a widget's unique id
  64          * @return id String label of the widget's unique id
  65          */
  66         public function getWidgetId() {
  67            return $this->widget_id;
  68         }
  69
  70         /**
  71          * setSubpanelWidgetId
  72          * This is a utility function to set the id for a widget
  73          * @param id String value to set the widget's unique id
  74          */
  75         public function setWidgetId($id='') {
  76                 $this->widget_id = $id;
  77         }
  78
  79    /**
  80     * getTruncatedColumnAlias
  81     * This function ensures that a column alias is no more than 28 characters.  Should the column_name
  82     * argument exceed 28 charcters, it creates an alias using the first 22 characters of the column_name
  83     * plus an md5 of the first 6 characters of the lowercased column_name value.
  84     *
  85     */
  86     protected function getTruncatedColumnAlias($column_name)
  87     {
  88                 if(empty($column_name) || !is_string($column_name) || strlen($column_name) < 28)
  89                 {
  90                    return $column_name;
  91                 }
  92             return strtoupper(substr($column_name,0,22) . substr(md5(strtolower($column_name)), 0, 6));
  93     }
  94 }
  95
  96 ?>