ZurmoDefaultViewUtil.php

<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2017. All rights reserved".
     ********************************************************************************/

    class ZurmoDefaultViewUtil
    {
        protected static $showRecentlyViewed = true;

        protected static $activeModuleId;

        public static function makeViewWithBreadcrumbsForCurrentUser(CController $controller,
                                                                     View $containedView,
                                                                     $breadCrumbLinks,
                                                                     $breadcrumbViewClassName,
                                                                     $cssClasses = array())
        {
            assert('is_array($breadCrumbLinks)');
            $gridView    = new GridView(2, 1);
            $gridView->setCssClasses($cssClasses);
            $gridView->setView(new $breadcrumbViewClassName($controller->getId(),
                                                            $controller->getModule()->getId(),
                                                            $breadCrumbLinks), 0, 0);
            $gridView->setView($containedView, 1, 0);
            return static::makeStandardViewForCurrentUser($controller, $gridView);
        }

        public static function makeTwoViewsWithBreadcrumbsForCurrentUser(CController $controller,
                                                                         View $containedView,
                                                                         View $secondContainedView,
                                                                         $breadCrumbLinks,
                                                                         $breadcrumbViewClassName,
                                                                         $cssClasses = array())
        {
            assert('is_array($breadCrumbLinks)');
            $gridView    = new GridView(3, 1);
            $gridView->setCssClasses($cssClasses);
            $gridView->setView(new $breadcrumbViewClassName($controller->getId(),
                                                            $controller->getModule()->getId(),
                                                            $breadCrumbLinks), 0, 0);
            $gridView->setView($containedView, 1, 0);
            $gridView->setView($secondContainedView, 2, 0);
            return static::makeStandardViewForCurrentUser($controller, $gridView);
        }

        public static function makeTwoStandardViewsForCurrentUser(CController $controller,
                                                                  View $containedView,
                                                                  View $secondContainedView,
                                                                  $cssClasses = array())
        {
            $gridView = new GridView(2, 1);
            $gridView->setCssClasses($cssClasses);
            $gridView->setView($containedView, 0, 0);
            $gridView->setView($secondContainedView, 1, 0);
            return static::makeStandardViewForCurrentUser($controller, $gridView);
        }

        public static function makeStandardViewForCurrentUser(CController $controller, View $containedView)
        {
            if (static::$showRecentlyViewed)
            {
                $verticalColumns = 3;
            }
            else
            {
                $verticalColumns = 2;
            }
            $aVerticalGridView   = new GridView($verticalColumns, 1, 'nav', false);
            $aVerticalGridView->setCssClasses( array('AppNavigation')); //navigation left column
            $aVerticalGridView->setView(static::makeMenuView($controller), 0, 0);
            if (static::$showRecentlyViewed)
            {
                $aVerticalGridView->setView(static::makeRecentlyViewedView(), 1, 0);
            }
            $aVerticalGridView->setView(new UserInterfaceChooserView(), ($verticalColumns - 1), 0);

            $horizontalGridView = new GridView(1, 3, 'section', false);
            $horizontalGridView->setCssClasses(array('AppContainer', 'container', 'clearfix')); //teh conatiner for the floated items
            $horizontalGridView->setView($aVerticalGridView, 0, 0);

            $containedView->setCssClasses(array_merge($containedView->getCssClasses(), array('AppContent'))); //the app itself to the right

            $horizontalGridView->setView($containedView, 0, 1);
            $horizontalGridView->setView(static::makeFlashMessageView($controller),   0, 2); //TODO needs to move into $containedView

            $verticalGridView   = new GridView(6, 1, null);
            $verticalGridView->setView(static::makeHeaderView($controller),                 0, 0);
            $verticalGridView->setView($horizontalGridView,                                 1, 0);
            $verticalGridView->setView(static::makeModalContainerView(),                    2, 0);
            $verticalGridView->setView(static::makeModalGameNotificationContainerView(),    3, 0);
            $verticalGridView->setView(static::makeGameCoinContainerView($controller),      4, 0);
            $verticalGridView->setView(static::makeFooterView(),                            5, 0);

            return $verticalGridView;
        }

        public static function makeAuthorizationViewForCurrentUser(CController $controller, View $containedView)
        {
            $horizontalGridView = new GridView(1, 1, 'section', false);
            $horizontalGridView->setCssClasses(array('AppContainer', 'container', 'clearfix'));
            $containedView->setCssClasses(array_merge($containedView->getCssClasses(), array('AppContent')));
            $horizontalGridView->setView($containedView, 0, 0);

            $verticalGridView   = new GridView(3, 1, null);
            $verticalGridView->setView(static::makeHeaderView($controller),         0, 0);
            $verticalGridView->setView($horizontalGridView,                         1, 0);
            $verticalGridView->setView(static::makeFooterView(),                    2, 0);
            return $verticalGridView;
        }

        public static function makeErrorViewForCurrentUser(CController $controller, View $containedView)
        {
            $aVerticalGridView   = new GridView(1, 1, 'nav', false);
            $aVerticalGridView->setCssClasses( array('AppNavigation')); //navigation left column
            $aVerticalGridView->setView(static::makeMenuView($controller), 0, 0);

            $horizontalGridView = new GridView(2, 1, 'section', false);
            $horizontalGridView->setCssClasses(array('AppContainer', 'container', 'clearfix')); //teh conatiner for the floated items
            $horizontalGridView->setView($aVerticalGridView, 0, 0);
            $containedView->setCssClasses(array_merge($containedView->getCssClasses(), array('AppContent', 'ErrorView'))); //the app itself to the right
            $horizontalGridView->setView($containedView, 1, 0);

            $verticalGridView   = new GridView(3, 1, null);
            $verticalGridView->setView(static::makeHeaderView($controller),         0, 0);
            $verticalGridView->setView($horizontalGridView,                         1, 0);
            $verticalGridView->setView(static::makeFooterView(),                    2, 0);
            return $verticalGridView;
        }

        protected static function makeHeaderView(CController $controller)
        {
            $headerView               = null;
            $settingsMenuItems        = MenuUtil::getOrderedAccessibleHeaderMenuForCurrentUser();
            $settingsMenuItems        = static::resolveHeaderMenuItemsForMobile($settingsMenuItems);
            $userMenuItems            = static::getAndResolveUserMenuItemsForHeader();
            $applicationName          = ZurmoConfigurationUtil::getByModuleName('ZurmoModule', 'applicationName');
            $shortcutsCreateMenuItems = MenuUtil::getAccessibleShortcutsCreateMenuByCurrentUser();
            $moduleNamesAndLabels     = GlobalSearchUtil::
                                        getGlobalSearchScopingModuleNamesAndLabelsDataByUser(Yii::app()->user->userModel);
            $sourceUrl                = Yii::app()->createUrl('zurmo/default/globalSearchAutoComplete');
            GlobalSearchUtil::resolveModuleNamesAndLabelsDataWithAllOption($moduleNamesAndLabels);
            $headerView = new HeaderView(  $settingsMenuItems,
                                           $userMenuItems,
                                           $shortcutsCreateMenuItems,
                                           $moduleNamesAndLabels,
                                           $sourceUrl,
                                           $applicationName);
            $headerView->setCssClasses(array('HeaderView'));
            return $headerView;
        }

        protected static function resolveHeaderMenuItemsForMobile(Array $items)
        {
            if (Yii::app()->userInterface->isMobile())
            {
                $resolvedItems = array();
                foreach ($items as $item)
                {
                    if (!isset($item['mobile']) || $item['mobile'] == true)
                    {
                        $resolvedItems[] = $item;
                    }
                }
            }
            else
            {
                $resolvedItems = $items;
            }
            return $resolvedItems;
        }

        protected static function getAndResolveUserMenuItemsForHeader()
        {
            $userMenuItems             = MenuUtil::getAccessibleOrderedUserHeaderMenuForCurrentUser();
            return $userMenuItems;
        }

        protected static function makeMenuView($controller = null)
        {
            assert('$controller == null || $controller instanceof CController');
            $items = MenuUtil::resolveByCacheAndGetVisibleAndOrderedTabMenuByCurrentUser();
            $useMinimalDynamicLabelMbMenu = false;
            static::resolveForMobileInterface($items, $useMinimalDynamicLabelMbMenu, $controller);
            static::resolveForActiveMenuItem($items, $controller);
            return new MenuView($items, $useMinimalDynamicLabelMbMenu);
        }

        protected static function resolveForActiveMenuItem(&$items, $controller)
        {
            assert('$controller == null || $controller instanceof CController');
            assert('is_array($items)');
            foreach ($items as $key => $item)
            {
                if ($controller != null && isset($item['moduleId']) &&
                    static::resolveActiveModuleId($controller) == $item['moduleId'])
                {
                    $items[$key]['active'] = true;
                    if (isset($items[$key]['items']))
                    {
                        try
                        {
                            $url        = Yii::app()->urlManager->parseUrl(Yii::app()->request);
                            foreach ($items[$key]['items'] as $subItemKey => $subItem)
                            {
                                $subItemUrl = $subItem['url'];
                                if (stristr($subItemUrl[0], $url) == $url)
                                {
                                    if (isset($_GET['moduleClassName']) && isset($subItemUrl['moduleClassName']) && $_GET['moduleClassName'] == $subItemUrl['moduleClassName'])
                                    {
                                        $items[$key]['items'][$subItemKey]['active'] = true;
                                    }
                                    elseif (isset($_GET['moduleClassName']) && isset($subItemUrl['moduleClassName']) && $_GET['moduleClassName'] != $subItemUrl['moduleClassName'])
                                    {
                                        $items[$key]['items'][$subItemKey]['active'] = false;
                                    }
                                    else
                                    {
                                        $items[$key]['items'][$subItemKey]['active'] = true;
                                    }
                                }
                            }
                        }
                        catch (Exception $exception)
                        {
                            //Do nothing
                        }
                    }
                }
            }
        }

        protected static function resolveActiveModuleId($controller)
        {
            if (static::$activeModuleId != null)
            {
                return static::$activeModuleId;
            }
            return $controller->resolveAndGetModuleId();
        }

        protected static function makeRecentlyViewedView()
        {
            $items = AuditEventsRecentlyViewedUtil::getRecentlyViewedItemsByUser(Yii::app()->user->userModel, 10);
            return new RecentlyViewedView($items);
        }

        protected static function makeFlashMessageView(CController $controller)
        {
            return new FlashMessageView($controller);
        }

        protected static function makeModalContainerView()
        {
            return new ModalContainerView();
        }

        protected static function makeModalGameNotificationContainerView()
        {
            return new ModalGameNotificationContainerView(GameNotification::getAllByUser(Yii::app()->user->userModel));
        }

        protected static function makeGameCoinContainerView(CController $controller)
        {
            return new GameCoinContainerView($controller);
        }

        protected static function makeFooterView()
        {
            return new FooterView();
        }

        protected static function resolveForMobileInterface(& $items, & $useMinimalDynamicLabelMbMenu, $controller = null)
        {
            if (Yii::app()->userInterface->isMobile())
            {
                foreach ($items as $key => $item)
                {
                    if (isset($item['mobile']) && $item['mobile'] == false)
                    {
                        unset($items[$key]);
                    }
                }
            }
            else
            {
                return;
            }
        }

        protected static function resolveShortcutsCreateMenuItemsForMobile(& $shortcutsCreateMenuItems)
        {
            if (!empty($shortcutsCreateMenuItems['items']))
            {
                foreach ($shortcutsCreateMenuItems['items'] as $key => $item)
                {
                    if (isset($item['mobile']) && $item['mobile'] == false)
                    {
                        unset($shortcutsCreateMenuItems['items'][$key]);
                    }
                }
            }
        }

        public static function setLockKeyForDetailsAndRelationsView($key, $value)
        {
            assert('is_bool($value)');
            Yii::app()->user->setState($key, $value);
        }

        public static function getLockKeyForDetailsAndRelationsView($key)
        {
            return Yii::app()->user->getState($key);
        }

        public static function renderActionBarLinksForKanbanBoard($controllerId, $moduleId, $modelId, $kanbanIsActive)
        {
            assert('is_string($controllerId)');
            assert('is_string($moduleId)');
            assert('is_int($modelId)');
            assert('is_bool($kanbanIsActive)');
            if ($kanbanIsActive)
            {
                $active = DetailsAndRelationsViewTypesToggleLinkActionElement::TYPE_KANBAN_BOARD;
            }
            else
            {
                $active = DetailsAndRelationsViewTypesToggleLinkActionElement::TYPE_NON_KANBAN_BOARD;
            }
            $toggleLinkActionElement = new DetailsAndRelationsViewTypesToggleLinkActionElement(
                                       $controllerId, $moduleId, $modelId, array('active' => $active));
            return $toggleLinkActionElement->render();
        }
    }
?>