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

    /**
     * Base View for showing a  progress bar and 'steps' in that progress bar. For use with a wizard view such as reporting
     * or workflow.
     */
    abstract class StepsAndProgressBarForWizardView extends MetadataView
    {
        protected $zeroBasedStepIndex = 0;

        /**
         * @return array
         */
        abstract protected function getSpanLabels();

        public function __construct($zeroBasedStepIndex = 0)
        {
            assert('is_int($zeroBasedStepIndex)');
            $this->zeroBasedStepIndex = $zeroBasedStepIndex;
        }

        public function isUniqueToAPage()
        {
            return true;
        }

        protected function renderContent()
        {
            $width = $this->getSpanPercentWidthFromCount() * ($this->zeroBasedStepIndex + 1);
            $content = ZurmoHtml::tag('div', array('class' => 'progress-bar',
                                                   'style' => 'width:' . $width . '%; margin-left:0%'), '');
            $content = ZurmoHtml::tag('div', array('class' => 'progress-back'), $content);
            $spanContent = $this->getSpanContent();
            return ZurmoHtml::tag('div', array('class' => 'progress'), $content . $spanContent);
        }

        protected function getSpanContent()
        {
            $width = $this->getSpanPercentWidthFromCount();
            $content = null;
            $first   = true;
            foreach ($this->getSpanLabels() as $step => $label)
            {
                $htmlOptions          = array();
                $htmlOptions['style'] = 'width:' . $width . '%';
                if ($this->zeroBasedStepIndex === $step)
                {
                    $htmlOptions['class'] = 'current-step';
                }
                $content .= ZurmoHtml::tag('span', $htmlOptions, $label);
                $first    = false;
            }
            return $content;
        }

        protected function getSpanPercentWidthFromCount()
        {
            $width  = 100 / count($this->getSpanLabels());
            return $width;
        }
    }
?>