<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2013 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. 2013. All rights reserved".
     ********************************************************************************/

    /**
     * The base View for a model detail view with relation views.
     */
    abstract class DetailsAndRelationsView extends ConfigurableMetadataView
    {
        protected $controllerId;

        protected $moduleId;

        protected $uniqueLayoutId;

        protected $params;

        /**
         * @param string $controllerId
         * @param string moduleId
         * @param array $params
         */
        public function __construct($controllerId, $moduleId, $params)
        {
            assert('isset($params["controllerId"])');
            assert('isset($params["relationModuleId"])');
            assert('isset($params["relationModel"])');
            $this->controllerId        = $controllerId;
            $this->moduleId            = $moduleId;
            $this->uniqueLayoutId      = get_class($this);
            $this->params              = $params;
        }

        protected function renderContent()
        {
            $metadata = self::getMetadata();
            $leftBottomMetadataForPortlets['global'] = $metadata['global']['leftBottomView'];
            $leftTopView    = $this->makeLeftTopView($metadata);
            $viewClassName  = static::getModelRelationsSecuredPortletFrameViewClassName();
            $leftBottomView = new $viewClassName(   $this->controllerId,
                                                    $this->moduleId,
                                                    $this->uniqueLayoutId . 'LeftBottomView',
                                                    $this->params,
                                                    $leftBottomMetadataForPortlets,
                                                    false,
                                                    false,
                                                    $metadata['global']['leftBottomView']['showAsTabbed'],
                                                    '100',
                                                    false
                                                );
            if (isset($metadata['global']['rightTopView']))
            {
                $renderRightSide                         = true;
                $rightTopMetadataForPortlets['global']   = $metadata['global']['rightTopView'];
                $viewClassName = static::getModelRelationsSecuredPortletFrameViewClassName();
                $rightTopView  = new $viewClassName( $this->controllerId,
                                                     $this->moduleId,
                                                     $this->uniqueLayoutId . 'RightBottomView',
                                                     $this->params,
                                                     $rightTopMetadataForPortlets,
                                                     false,
                                                     false,
                                                     false,
                                                     '100',
                                                     false);
            }
            else
            {
                $renderRightSide = false;
                $rightTopView    = null;
            }
            $this->renderScripts();
            return $this->renderLeftAndRightGridViewContent($leftTopView, $leftBottomView, $rightTopView, $renderRightSide);
        }

        protected function makeLeftTopView($metadata)
        {
            $detailsViewClassName                    = $metadata['global']['leftTopView']['viewClassName'];
            if (is_subclass_of($detailsViewClassName, 'EditAndDetailsView'))
            {
                $leftTopView    = new $detailsViewClassName('Details',
                                                            $this->params["controllerId"],
                                                            $this->params["relationModuleId"],
                                                            $this->params["relationModel"]);
            }
            else
            {
                $leftTopView    = new $detailsViewClassName($this->params["controllerId"],
                                                            $this->params["relationModuleId"],
                                                            $this->params["relationModel"]);
            }
            return $leftTopView;
        }

        protected function renderLeftAndRightGridViewContent($leftTopView, $leftBottomView, $rightTopView, $renderRightSide)
        {
            assert('$leftTopView instanceof View');
            assert('$leftBottomView instanceof View');
            assert('$rightTopView instanceof View || $rightTopView == null');
            assert('is_bool($renderRightSide)');
            $leftVerticalGridView  = new GridView(2, 1);
            $leftVerticalGridView->setView($leftTopView, 0, 0);
            $leftVerticalGridView->setView($leftBottomView, 1, 0);
            $content = $leftVerticalGridView->render();
            if ($renderRightSide)
            {
                $this->setCssClasses(array_merge($this->getCssClasses(), array('double-column')));
                $rightVerticalGridView  = new GridView(1, 1);
                $rightVerticalGridView->setView($rightTopView, 0, 0);
                $content .= $rightVerticalGridView->render();
            }
            else
            {
                $this->setCssClasses(array_merge($this->getCssClasses(), array('single-column')));
            }
            return $content;
        }

        protected static function getModelRelationsSecuredPortletFrameViewClassName()
        {
            return 'ModelRelationsSecuredPortletFrameView';
        }

        protected function renderScripts()
        {
        }
    }
?>