MetadataView.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".
     ********************************************************************************/

    abstract class MetadataView extends View
    {
        protected $editableDesignerMetadata = false;

        protected $disableFloatOnToolbar  = false;

        protected $modelId;

        public static function getMetadata()
        {
            $className = get_called_class();
            return $className::getDefaultMetadata();
        }

        public static function getDefaultMetadata()
        {
            return array();
        }

        protected function resolveAndWrapDockableViewToolbarContent($content)
        {
            assert('is_string($content)');
            if ($this->disableFloatOnToolbar)
            {
                $disableFloatContent = ' disable-float-bar';
            }
            else
            {
                $disableFloatContent = null;
            }
            $content = ZurmoHtml::tag('div', array('class' => 'form-toolbar'), $content);
            $content = ZurmoHtml::tag('div', array('class' => 'view-toolbar-container clearfix dock' .
                       $disableFloatContent), $content);
            $content = ZurmoHtml::tag('div', array('class' => 'float-bar'), $content);
            return $content;
        }

        protected function renderViewToolBar($renderInForm = true)
        {
            if ( $renderInForm == true )
            {
                $actionContent = $this->renderActionElementBar($renderInForm);
                if ($actionContent != null)
                {
                    $content  = '<div class="view-toolbar-container clearfix"><div class="portlet-toolbar">';
                    $content .= $actionContent;
                    $content .= '</div></div>';
                    return $content;
                }
            }
            return null;
        }

        protected function renderActionElementBar($renderedInForm)
        {
            return $this->renderElementBar($renderedInForm, 'toolbar');
        }

        protected function renderSecondActionElementBar($renderedInForm)
        {
            return $this->renderElementBar($renderedInForm, 'secondToolbar');
        }

        protected function renderElementBar($renderedInForm, $barType)
        {
            assert('$barType == "toolbar" || $barType == "secondToolbar"');
            $metadata = $this::getMetadata();
            $content = null;
            $first = true;
            $dropDownId = null;
            $dropDownItems = array();
            $dropDownItemHtmlOptions = array('prompt' => ''); // we need this so we have a default one to select at the end of operation.
            if (isset($metadata['global'][$barType]) && is_array($metadata['global'][$barType]['elements']))
            {
                foreach ($metadata['global'][$barType]['elements'] as $elementInformation)
                {
                    $renderedContent = null;
                    $this->resolveActionElementInformationDuringRender($elementInformation);
                    Yii::app()->custom->resolveActionElementInformationDuringRender($this, $elementInformation);
                    array_walk($elementInformation, array($this, 'resolveEvaluateSubString'));
                    $params = array_slice($elementInformation, 1);
                    $elementClassName = $elementInformation['type'] . 'ActionElement';
                    $element  = new $elementClassName($this->controllerId, $this->moduleId, $this->modelId, $params);
                    if (!$this->shouldRenderToolBarElement($element, $elementInformation))
                    {
                        continue;
                    }
                    if (!$renderedInForm && $element->isFormRequiredToUse())
                    {
                        throw new NotSupportedException();
                    }
                    $continueRendering = $this->resolveMassActionLinkActionElementDuringRender($elementClassName,
                        $element,
                        $dropDownItems,
                        $dropDownItemHtmlOptions
                    );
                    if ($continueRendering)
                    {
                        $renderedContent = $element->render();
                    }
                    else
                    {
                        if (! $dropDownId)
                        {
                            $dropDownId = $elementClassName::getDropdownId();
                        }
                    }
                    if (!$first && !empty($renderedContent))
                    {
                        // $content .= '&#160;|&#160;';
                    }
                    $first = false;
                    $content .= $renderedContent;
                }
            }
            return $content;
        }

        protected function resolveMassActionLinkActionElementDuringRender($elementClassName, & $element, & $dropDownItems, & $dropDownItemHtmlOptions)
        {
            $class = new ReflectionClass($elementClassName);
            if ($class->implementsInterface('SupportsRenderingDropDownInterface') &&
                $elementClassName::shouldRenderAsDropDownWhenRequired() &&
                Yii::app()->userInterface->isMobile())
            {
                if (empty($dropDownItems))
                {
                    $element->registerDropDownScripts();
                }
                $items = $element->getOptions();
                if (array_key_exists('label', $items))
                {
                    $items = array($items);
                }
                foreach ($items as $item)
                {
                    if ($element::useItemUrlAsElementValue())
                    {
                        $value      = $item['url'];
                    }
                    else
                    {
                        $value      = $element->getElementValue();
                    }

                    if (!$value)
                    {
                        $value      = $element->getActionNameForCurrentElement() . '_' . $item['label'];
                    }
                    $optGroup   = $element->getOptGroup();
                    if ($optGroup)
                    {
                        $dropDownItems[$optGroup][$value]   = $item['label'];
                    }
                    else
                    {
                        $dropDownItems[$value]              = $item['label'];
                    }
                    $dropDownItemHtmlOptions['options'][$value] = array();
                    if (isset($item['itemOptions']))
                    {
                        $dropDownItemHtmlOptions['options'][$value] = $item['itemOptions'];
                    }
                }
                return false;
            }
            return true;
        }

        protected function resolveActionElementInformationDuringRender(& $elementInformation)
        {
        }

        public function resolveEvaluateSubString(& $element, $key)
        {
            if (is_array($element))
            {
                array_walk($element, array($this, 'resolveEvaluateSubString'));
                return;
            }
            if (strpos($element, 'eval:') !== 0)
            {
                return;
            }
            $stringToEvaluate = substr($element, 5);
            eval("\$element = $stringToEvaluate;");
        }

        public static function getDesignerRulesType()
        {
            return null;
        }

        public static function getModelForMetadataClassName()
        {
            return null;
        }

        protected function shouldRenderToolBarElement($element, $elementInformation)
        {
            assert('$element instanceof ActionElement');
            assert('is_array($elementInformation)');
            return true;
        }

        protected function renderWrapperAndActionElementMenu($title = null, $toolbar = 'toolbar')
        {
            assert('is_string($title) || $title === null');
            assert('is_string($toolbar)');
            $content              = null;
            $actionElementContent = $this->renderActionElementMenu($title, $toolbar);
            if ($actionElementContent != null)
            {
                $content .= '<div class="view-toolbar-container toolbar-mbmenu clearfix"><div class="view-toolbar">';
                $content .= $actionElementContent;
                $content .= '</div></div>';
            }
            return $content;
        }

        protected function renderActionElementMenu($title = null, $toolbar = 'toolbar')
        {
            assert('is_string($toolbar)');
            if ($title == null)
            {
                $title = Zurmo::t('Core', 'Options');
            }
            $metadata  = $this::getMetadata();
            $menuItems = array('label' => $title, 'items' => array());
            if (isset($metadata['global'][$toolbar]) && is_array($metadata['global'][$toolbar]['elements']))
            {
                foreach ($metadata['global'][$toolbar]['elements'] as $elementInformation)
                {
                    $elementClassName  = $elementInformation['type'] . 'ActionElement';
                    $params            = array_slice($elementInformation, 1);
                    array_walk($params, array($this, 'resolveEvaluateSubString'));
                    $element  = new $elementClassName($this->controllerId, $this->moduleId, $this->modelId, $params);
                    if (!$this->shouldRenderToolBarElement($element, $elementInformation))
                    {
                        continue;
                    }
                    if ($element->isFormRequiredToUse())
                    {
                        throw new NotSupportedException();
                    }
                    $menuItems['items'][] = $element->renderMenuItem();
                }
            }
            if (count($menuItems['items']) > 0)
            {
                $cClipWidget = new CClipWidget();
                $cClipWidget->beginClip("OptionMenu");
                $cClipWidget->widget('application.core.widgets.MbMenu', array(
                    'htmlOptions' => array('class' => static::getOptionsMenuCssClass()),
                    'items'                   => array($menuItems),
                ));
                $cClipWidget->endClip();
                return $cClipWidget->getController()->clips['OptionMenu'];
            }
        }

        protected static function getOptionsMenuCssClass()
        {
            return 'options-menu';
        }
    }
?>