Zurmo: /home/apizurmo/zurmo/app/protected/core/rules/ChartRules.php Source File

00001 <?php
00002     /*********************************************************************************
00003      * Zurmo is a customer relationship management program developed by
00004      * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
00005      *
00006      * Zurmo is free software; you can redistribute it and/or modify it under
00007      * the terms of the GNU Affero General Public License version 3 as published by the
00008      * Free Software Foundation with the addition of the following permission added
00009      * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
00010      * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
00011      * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
00012      *
00013      * Zurmo is distributed in the hope that it will be useful, but WITHOUT
00014      * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00015      * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
00016      * details.
00017      *
00018      * You should have received a copy of the GNU Affero General Public License along with
00019      * this program; if not, see http://www.gnu.org/licenses or write to the Free
00020      * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00021      * 02110-1301 USA.
00022      *
00023      * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
00024      * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
00025      *
00026      * The interactive user interfaces in original and modified versions
00027      * of this program must display Appropriate Legal Notices, as required under
00028      * Section 5 of the GNU Affero General Public License version 3.
00029      *
00030      * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
00031      * these Appropriate Legal Notices must retain the display of the Zurmo
00032      * logo and Zurmo copyright notice. If the display of the logo is not reasonably
00033      * feasible for technical reasons, the Appropriate Legal Notices must display the words
00034      * "Copyright Zurmo Inc. 2017. All rights reserved".
00035      ********************************************************************************/
00036 
00040     class ChartRules
00041     {
00042         const TYPE_BAR_2D                = 'Bar2D';
00043 
00044         const TYPE_BAR_3D                = 'Bar3D';
00045 
00046         const TYPE_COLUMN_2D             = 'Column2D';
00047 
00048         const TYPE_COLUMN_3D             = 'Column3D';
00049 
00050         const TYPE_DONUT_2D              = 'Donut2D';
00051 
00052         const TYPE_DONUT_3D              = 'Donut3D';
00053 
00054         const TYPE_PIE_2D                = 'Pie2D';
00055 
00056         const TYPE_PIE_3D                = 'Pie3D';
00057 
00058         const TYPE_STACKED_BAR_2D        = 'StackedBar2D';
00059 
00060         const TYPE_STACKED_BAR_3D        = 'StackedBar3D';
00061 
00062         const TYPE_STACKED_COLUMN_2D     = 'StackedColumn2D';
00063 
00064         const TYPE_STACKED_COLUMN_3D     = 'StackedColumn3D';
00065 
00066         const TYPE_STACKED_AREA          = 'StackedArea';
00067 
00068         const TYPE_LINE                  = 'Line';
00069 
00070         const TYPE_DONUT_PROGRESSION     = 'DonutProgression';
00071 
00072         const TYPE_FUNNEL                = 'Funnel';
00073 
00074         const TYPE_PYRAMID               = 'Pyramid';
00075 
00076         const TYPE_RADAR                 = 'Radar';
00077 
00081         public static function getChartTypesRequiringSecondInputs()
00082         {
00083             return array(self::TYPE_STACKED_BAR_2D,
00084                          self::TYPE_STACKED_BAR_3D,
00085                          self::TYPE_STACKED_COLUMN_2D,
00086                          self::TYPE_STACKED_COLUMN_3D,
00087                          self::TYPE_STACKED_AREA,
00088             );
00089         }
00090 
00091         public static function isStacked($type)
00092         {
00093             assert('is_string($type)');
00094             if (in_array($type, self::getChartTypesRequiringSecondInputs()))
00095             {
00096                 return true;
00097             }
00098             return false;
00099         }
00100 
00101         public static function getTranslatedTypeLabel($type)
00102         {
00103             assert('is_string($type)');
00104             $labels             = self::translatedTypeLabels();
00105             if (isset($labels[$type]))
00106             {
00107                 return $labels[$type];
00108             }
00109             throw new NotSupportedException();
00110         }
00111 
00112         public static function translatedTypeLabels()
00113         {
00114             return array(ChartRules::TYPE_BAR_2D             => Zurmo::t('Core', '2D Horizontal Bar Graph'),
00115                          ChartRules::TYPE_BAR_3D             => Zurmo::t('Core', '3D Horizontal Bar Graph'),
00116                          ChartRules::TYPE_COLUMN_2D          => Zurmo::t('Core', '2D Vertical Bar Graph'),
00117                          ChartRules::TYPE_COLUMN_3D          => Zurmo::t('Core', '3D Vertical Bar Graph'),
00118                          ChartRules::TYPE_DONUT_2D           => Zurmo::t('Core', 'Donut 2D'),
00119                          ChartRules::TYPE_DONUT_3D           => Zurmo::t('Core', 'Donut 3D'),
00120                          ChartRules::TYPE_PIE_2D             => Zurmo::t('Core', 'Pie 2D'),
00121                          ChartRules::TYPE_PIE_3D             => Zurmo::t('Core', 'Pie 3D'),
00122                          ChartRules::TYPE_STACKED_BAR_2D     => Zurmo::t('Core', 'Stacked Bar 2D'),
00123                          ChartRules::TYPE_STACKED_BAR_3D     => Zurmo::t('Core', 'Stacked Bar 3D'),
00124                          ChartRules::TYPE_STACKED_COLUMN_2D  => Zurmo::t('Core', 'Stacked Column 2D'),
00125                          ChartRules::TYPE_STACKED_COLUMN_3D  => Zurmo::t('Core', 'Stacked Column 3D'),
00126                          ChartRules::TYPE_STACKED_AREA       => Zurmo::t('Core', 'Stacked Area'),
00127                          ChartRules::TYPE_DONUT_PROGRESSION  => Zurmo::t('Core', 'Donut Progression'),
00128                          ChartRules::TYPE_FUNNEL             => Zurmo::t('Core', 'Funnel'),
00129                          ChartRules::TYPE_PYRAMID            => Zurmo::t('Core', 'Pyramid'),
00130                          ChartRules::TYPE_RADAR              => Zurmo::t('Core', 'Radar')
00131             );
00132         }
00133 
00134         public static function availableTypes()
00135         {
00136             return array(ChartRules::TYPE_BAR_2D,
00137                          ChartRules::TYPE_BAR_3D,
00138                          ChartRules::TYPE_COLUMN_2D,
00139                          ChartRules::TYPE_COLUMN_3D,
00140                          ChartRules::TYPE_DONUT_2D,
00141                          ChartRules::TYPE_DONUT_3D,
00142                          ChartRules::TYPE_PIE_2D,
00143                          ChartRules::TYPE_PIE_3D,
00144                          ChartRules::TYPE_STACKED_BAR_2D,
00145                          ChartRules::TYPE_STACKED_BAR_3D,
00146                          ChartRules::TYPE_STACKED_COLUMN_2D,
00147                          ChartRules::TYPE_STACKED_COLUMN_3D,
00148                          ChartRules::TYPE_STACKED_AREA,
00149                          ChartRules::TYPE_FUNNEL,
00150                          ChartRules::TYPE_PYRAMID,
00151             );
00152         }
00153 
00154         public static function getSingleSeriesDataAndLabels()
00155         {
00156             $translatedLabels = static::translatedTypeLabels();
00157             return array(
00158                 ChartRules::TYPE_COLUMN_2D => $translatedLabels[ChartRules::TYPE_COLUMN_2D],
00159                 ChartRules::TYPE_COLUMN_3D => $translatedLabels[ChartRules::TYPE_COLUMN_3D],
00160                 ChartRules::TYPE_BAR_2D    => $translatedLabels[ChartRules::TYPE_BAR_2D],
00161                 ChartRules::TYPE_BAR_3D    => $translatedLabels[ChartRules::TYPE_BAR_3D],
00162                 ChartRules::TYPE_DONUT_2D  => $translatedLabels[ChartRules::TYPE_DONUT_2D],
00163                 ChartRules::TYPE_DONUT_3D  => $translatedLabels[ChartRules::TYPE_DONUT_3D],
00164                 ChartRules::TYPE_PIE_2D    => $translatedLabels[ChartRules::TYPE_PIE_2D],
00165                 ChartRules::TYPE_PIE_3D    => $translatedLabels[ChartRules::TYPE_PIE_3D],
00166                 ChartRules::TYPE_FUNNEL    => $translatedLabels[ChartRules::TYPE_FUNNEL],
00167                 ChartRules::TYPE_PYRAMID   => $translatedLabels[ChartRules::TYPE_PYRAMID],
00168             );
00169         }
00170     }
00171 ?>