ReportDetailsView.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 ReportDetailsView extends DetailsView
    {
        protected $savedReport;

        public function __construct($controllerId, $moduleId, Report $model, $title = null, SavedReport$savedReport)
        {
            parent::__construct($controllerId, $moduleId, $model);
            $this->savedReport = $savedReport;
        }

        public static function assertModelIsValid($model)
        {
            assert('$model instanceof Report');
        }

        public static function getDefaultMetadata()
        {
            $metadata = array(
                'global' => array(
                    'toolbar' => array(
                        'elements' => array(
                            array('type'        => 'ReportOptionsMenu',
                                  'iconClass'   => 'icon-options',
                                  'htmlOptions' => array('id' => 'ListViewOptionsActionMenu'),
                            ),
                            array('type'        => 'ReportExportMenu',
                                  'iconClass'   => 'icon-export',
                                  'htmlOptions' => array('id' => 'ListViewExportActionMenu'),
                            ),
                            array('type'  => 'ReportTogglePortletsLink',
                                  'htmlOptions' => array('class' => 'hasCheckboxes'),
                                  'hasRuntimeFilters' => 'eval:$this->model->hasRuntimeFilters()',
                                  'hasChart'          => 'eval:$this->model->hasChart()'
                            ),
                        ),
                    ),
                ),
            );
            return $metadata;
        }

        public function getTitle()
        {
            if ($this->model->id > 0)
            {
                $moduleClassName = $this->model->moduleClassName;
                $moduleLabel = $this->getPuralModuleLabelForReportTitle($moduleClassName);
                $typesAndLabels  = Report::getTypeDropDownArray();
                $title = strval($this->model) . ' - ' .
                       Zurmo::t('ReportsModule', '{moduleLabel} {typeLabel} Report',
                              array('{moduleLabel}' => $moduleLabel,
                                    '{typeLabel}'   => $typesAndLabels[$this->model->type]));
                return $title;
            }
            else
            {
                throw new NotSupportedException();
            }
        }

        public function getPuralModuleLabelForReportTitle($moduleClassName)
        {
            $moduleLabels = Report::getReportableModulesAndLabelsForCurrentUser();
            $moduleLabel = $moduleClassName::getModuleLabelByTypeAndLanguage('Plural');
            if (isset($moduleLabels[$moduleClassName]))
            {
                $moduleLabel = $moduleLabels[$moduleClassName];
            }
            return $moduleLabel;
        }

        public function registerScripts()
        {
            $script = '$(".ReportSQLForPortletView").hide();';
            Yii::app()->getClientScript()->registerScript('ReportPortletsDefaultHideScript', $script);
            Yii::app()->getClientScript()->registerCoreScript('bbq');
        }

        protected function renderContent()
        {
            $content = $this->renderTitleContent();
            $content .= '<div class="view-toolbar-container clearfix"><nav class="pillbox clearfix">';
            $content .= $this->renderActionElementBar(false);
            $content .= '</nav></div>';
            $this->registerScripts();
            return $content;
        }

        public function getPostTruncatedTitleContent()
        {
            return StarredUtil::getToggleStarStatusLink($this->savedReport, null);
        }

        protected function shouldRenderToolBarElement($element, $elementInformation)
        {
            if (get_class($element) == 'ReportExportLinkActionElement' &&
                !$this->userCanExportReport())
            {
                return false;
            }
            if (get_class($element) == 'ReportOptionsLinkActionElement')
            {
                $userCanEditReport   = $this->userCanEditReport();
                $userCanDeleteReport = $this->userCanDeleteReport();
                $userCanCreateReport = $this->userCanCreateReport();
                if (!$userCanEditReport && !$userCanDeleteReport && !$userCanCreateReport)
                {
                    return false;
                }
                if (!$userCanEditReport)
                {
                    $element->setHideEdit();
                }
                if (!$userCanDeleteReport)
                {
                    $element->setHideDelete();
                }
                if (!$userCanCreateReport)
                {
                    $element->setHideCopy();
                }
            }
            return true;
        }

        protected function userCanCreateReport()
        {
            return ActionSecurityUtil::canCurrentUserPerformAction('Create', $this->savedReport);
        }

        protected function userCanEditReport()
        {
            return ActionSecurityUtil::canCurrentUserPerformAction('Edit', $this->savedReport);
        }

        protected function userCanDeleteReport()
        {
            return ActionSecurityUtil::canCurrentUserPerformAction('Delete', $this->savedReport);
        }

        protected function userCanExportReport()
        {
            return ActionSecurityUtil::canCurrentUserPerformAction('Export', $this->savedReport);
        }
    }
?>