Zurmo: /home/apizurmo/zurmo/app/protected/core/utils/SlidingPanelsUtil.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     abstract class SlidingPanelsUtil
00041     {
00042         const SHOULD_SLIDE_TO_FIRST_PANEL_KEY_NAME = 'slideToFirstPanel';
00043 
00048         public static function getSlideToSecondPanelLabel()
00049         {
00050             throw new NotImplementedException();
00051         }
00052 
00057         public static function getSlideToFirstPanelLabel()
00058         {
00059             throw new NotImplementedException();
00060         }
00061 
00066         public static function renderToggleLinkContent($portletId)
00067         {
00068             if (static::resolveShouldSlideToSecondPanel($portletId))
00069             {
00070                 $slideToSecond = true;
00071             }
00072             else
00073             {
00074                 $slideToSecond = false;
00075             }
00076             static::registerSlidingPanelsScript($portletId);
00077             if ($slideToSecond)
00078             {
00079                 $label      = static::getSlideToSecondPanelLabel();
00080                 $extraClass = ' slide-to-second-panel';
00081             }
00082             else
00083             {
00084                 $label      = static::getSlideToFirstPanelLabel();
00085                 $extraClass = null;
00086             }
00087             $content  = ZurmoHtml::tag('span', array(), $label);
00088             $content  = ZurmoHtml::link($content, '#', array('id'    => 'sliding-panel-toggle',
00089                                                              'class' => 'vertical-forward-pager' . $extraClass));
00090             return $content;
00091         }
00092 
00093         public static function setShouldSlideToSecondPanelForCurrentUser($portletId, $shouldSlideToSecondPanel)
00094         {
00095             assert('is_bool($shouldSlideToSecondPanel)');
00096             LatestActivitiesPortletPersistentConfigUtil::
00097                 setForCurrentUserByPortletIdAndKey($portletId, static::SHOULD_SLIDE_TO_FIRST_PANEL_KEY_NAME, !$shouldSlideToSecondPanel);
00098         }
00099 
00104         public static function resolveShouldSlideToSecondPanel($portletId)
00105         {
00106             return !(LatestActivitiesPortletPersistentConfigUtil::
00107                 getForCurrentUserByPortletIdAndKey($portletId, static::SHOULD_SLIDE_TO_FIRST_PANEL_KEY_NAME, true));
00108         }
00109 
00110         protected static function registerSlidingPanelsScript($portletId)
00111         {
00112             $script = "
00113                 $('#sliding-panel-toggle').click(function()
00114                 {
00115                     $('.sliding-panel').slideToggle();
00116                     $('.sliding-panel').toggleClass('showing-panel');
00117                     if ($(this).hasClass('slide-to-second-panel'))
00118                     {
00119                         $(this).removeClass('slide-to-second-panel');
00120                         $(this).addClass('slide-to-first-panel');
00121                         $(this).find('span').text('" . static::getSlideToFirstPanelLabel() . "');
00122                         " . static::getAjaxSubmitScript($portletId, false) . "
00123                     }
00124                     else
00125                     {
00126                         $(this).removeClass('slide-to-first-panel');
00127                         $(this).addClass('slide-to-second-panel');
00128                         $(this).find('span').text('" . static::getSlideToSecondPanelLabel() . "');
00129                         " . static::getAjaxSubmitScript($portletId, true) . "
00130                     }
00131                     return false;
00132                 });
00133             ";
00134             Yii::app()->getClientScript()->registerScript('slidingPanelsScript', $script);
00135         }
00136 
00142         protected static function getAjaxSubmitScript($portletId, $shouldSlideToSecondPanel)
00143         {
00144             assert('is_bool($shouldSlideToSecondPanel)');
00145             $urlScript = 'js:$.param.querystring("' . static::getAjaxUpdateSlidingPanelShowingByDefaultUrl() . '", "' .
00146                          'portletId=' . $portletId . '&shouldSlideToSecondPanel=' . $shouldSlideToSecondPanel . '")'; // Not Coding Standard
00147             return ZurmoHtml::ajax(array('type' => 'GET', 'url' =>  $urlScript));
00148         }
00149 
00150         protected  static function getAjaxUpdateSlidingPanelShowingByDefaultUrl()
00151         {
00152             return Yii::app()->createUrl('/zurmo/default/ajaxUpdateSlidingPanelShowingByDefault');
00153         }
00154     }
00155 ?>