<?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 used to convert report models into arrays
     */
    abstract class ReportToExportAdapter
    {
        protected $dataProvider;

        protected $dataForExport;

        protected $dataForGrandTotals;

        protected $headerData;

        protected $data;

        protected $report;

        public function __construct(ReportDataProvider $dataProvider, Report $report)
        {
            $this->dataProvider       = $dataProvider;
            $this->report             = $report;
            $this->dataForExport      = $dataProvider->getData(true);
            $grandTotalsRows          = $dataProvider->runQueryAndGrandTotalsData();
            $this->dataForGrandTotals = $grandTotalsRows[0];
            $this->makeData();
        }

        public function getData()
        {
            return $this->data;
        }

        public function getHeaderData()
        {
            return $this->headerData;
        }

        /**
         * Override if needed to adapt the way data is made for export
         */
        protected function makeData()
        {
            $isFirstRow      = true;
            $grandTotalsData = array();
            foreach ($this->dataForExport as $reportResultsRowData)
            {
                $data                  = array();
                $this->headerData      = array();
                $isFirstColumn         = true;
                foreach ($reportResultsRowData->getDisplayAttributes() as $key => $displayAttribute)
                {
                    $resolvedAttributeName = $displayAttribute->resolveAttributeNameForGridViewColumn($key);
                    $className             = $this->resolveExportClassNameForReportToExportValueAdapter($displayAttribute);
                    $params                = array('label'      => $displayAttribute->label);
                    $this->resolveParamsForCurrencyTypes($displayAttribute, $params);
                    $this->resolveParamsForGrandTotals($displayAttribute, $params, $isFirstRow, $isFirstColumn);
                    $adapter = new $className($reportResultsRowData, $resolvedAttributeName, $params);
                    $adapter->resolveData($data);
                    $adapter->resolveHeaderData($this->headerData);
                    if ($isFirstRow)
                    {
                        $adapter->resolveGrandTotalsData($grandTotalsData);
                    }
                    $isFirstColumn = false;
                }
                $isFirstRow = false;
                $this->data[] = $data;
            }
            if (isset($this->dataForGrandTotals))
            {
                $this->data[] = $grandTotalsData;
            }
        }

        /**
         * @param DisplayAttributeForReportForm $displayAttribute
         * @return string
         */
        protected function resolveExportClassNameForReportToExportValueAdapter(DisplayAttributeForReportForm $displayAttribute)
        {
            $displayElementType = $displayAttribute->getDisplayElementType();
            if (@class_exists($displayElementType . 'ForReportToExportValueAdapter'))
            {
                return $displayElementType . 'ForReportToExportValueAdapter';
            }
            else
            {
                return $displayElementType . 'RedBeanModelAttributeValueToExportValueAdapter';
            }
        }

        /**
         * @param DisplayAttributeForReportForm $displayAttribute
         * @param array $params
         */
        protected function resolveParamsForCurrencyTypes(DisplayAttributeForReportForm $displayAttribute, & $params)
        {
            assert('is_array($params)');
            if ($displayAttribute->isATypeOfCurrencyValue())
            {
                $params['currencyValueConversionType'] = $this->report->getCurrencyConversionType();
                $params['spotConversionCurrencyCode']  = $this->report->getSpotConversionCurrencyCode();
                $params['fromBaseToSpotRate']          = $this->report->getFromBaseToSpotRate();
            }
        }

        protected function resolveParamsForGrandTotals(DisplayAttributeForReportForm $displayAttribute, & $params, $isFirstRow, $isFirstColumn)
        {
            $grandTotal = null;
            if (isset($this->dataForGrandTotals) && $isFirstColumn && $isFirstRow)
            {
                $grandTotal    = Zurmo::t('Core', 'Total');
            }
            if (isset($this->dataForGrandTotals[$displayAttribute->columnAliasName]) && !$isFirstColumn && $isFirstRow)
            {
                $grandTotal    = $this->dataForGrandTotals[$displayAttribute->columnAliasName];
            }
            if (isset($grandTotal))
            {
                $params['grandTotal'] = $grandTotal;
            }
        }
    }
?>