TbWizard.php

Go to the documentation of this file.

<?php
Yii::import('booster.widgets.TbMenu');

class TbWizard extends CWidget
{
        // Tab placements.
        const PLACEMENT_ABOVE = 'above';
        const PLACEMENT_BELOW = 'below';
        const PLACEMENT_LEFT = 'left';
        const PLACEMENT_RIGHT = 'right';

        public $type = TbMenu::TYPE_TABS;

        public $placement;

        public $tabs = array();

        public $stacked = false;

        public $encodeLabel = true;

        public $events = array();

        public $htmlOptions = array();

        public $options = array();

        public $addTabsNavBar = false;

        public $pagerContent = '<ul class="pager wizard">
                                <li class="previous first" style="display:none;"><a href="#">First</a></li>
                                <li class="previous"><a href="#">Previous</a></li>
                                <li class="next last" style="display:none;"><a href="#">Last</a></li>
                                <li class="next"><a href="#">Next</a></li>
                        </ul>';

        public function init()
        {
                if (!isset($this->htmlOptions['id'])) {
                        $this->htmlOptions['id'] = $this->getId();
                }

                $classes = array();

                $validPlacements = array(
                        self::PLACEMENT_ABOVE,
                        self::PLACEMENT_BELOW,
                        self::PLACEMENT_LEFT,
                        self::PLACEMENT_RIGHT
                );

                if (isset($this->placement) && in_array($this->placement, $validPlacements)) {
                        $classes[] = 'tabs-' . $this->placement;
                }

                if (!empty($classes)) {
                        $classes = implode(' ', $classes);
                        if (isset($this->htmlOptions['class'])) {
                                $this->htmlOptions['class'] .= ' ' . $classes;
                        } else {
                                $this->htmlOptions['class'] = $classes;
                        }
                }
        }

        public function run()
        {
                $id = $this->id;
                $content = array();
                $items = $this->normalizeTabs($this->tabs, $content);

                ob_start();
                if ($this->addTabsNavBar) {
                        echo '<div class="navbar"><div class="navbar-inner">';
                }
                $this->controller->widget(
                        'booster.widgets.TbMenu',
                        array(
                                'stacked' => $this->stacked,
                                'type' => $this->type,
                                'encodeLabel' => $this->encodeLabel,
                                'items' => $items,
                        )
                );
                if ($this->addTabsNavBar) {
                        echo '</div></div>';
                }
                $tabs = ob_get_clean();

                ob_start();
                echo '<div class="tab-content">';
                echo implode('', $content);
                echo $this->pagerContent;
                echo '</div>';
                $content = ob_get_clean();

                echo CHtml::openTag('div', $this->htmlOptions);
                echo $this->placement === self::PLACEMENT_BELOW ? $content . $tabs : $tabs . $content;
                echo '</div>';

                $cs = Yii::app()->getClientScript();

                $cs->registerPackage('bootstrap.wizard');

                // Override options
                if ($this->type && !isset($this->options['class'])) {
                        $this->options['class'] = $this->type;
                }

                $options = CJavaScript::encode($this->options);

                $cs->registerScript(__CLASS__ . '#' . $id, "jQuery('#{$id}').bootstrapWizard({$options});");

                foreach ($this->events as $name => $handler) {
                        $handler = CJavaScript::encode($handler);
                        $cs->registerScript(__CLASS__ . '#' . $id . '_' . $name, "jQuery('#{$id}').on('{$name}', {$handler});");
                }
        }

        protected function normalizeTabs($tabs, &$panes, &$i = 0)
        {
                $id = $this->getId();
                $items = array();

                foreach ($tabs as $tab) {
                        $item = $tab;

                        if (isset($item['visible']) && $item['visible'] === false) {
                                continue;
                        }

                        if (!isset($item['itemOptions'])) {
                                $item['itemOptions'] = array();
                        }

                        $item['linkOptions']['data-toggle'] = 'tab';

                        if (isset($tab['items'])) {
                                $item['items'] = $this->normalizeTabs($item['items'], $panes, $i);
                        } else {
                                if (!isset($item['id'])) {
                                        $item['id'] = $id . '_tab_' . ($i + 1);
                                }

                                $item['url'] = '#' . $item['id'];

                                if (!isset($item['content'])) {
                                        $item['content'] = '';
                                }

                                $content = $item['content'];
                                unset($item['content']);

                                if (!isset($item['paneOptions'])) {
                                        $item['paneOptions'] = array();
                                }

                                $paneOptions = $item['paneOptions'];
                                unset($item['paneOptions']);

                                $paneOptions['id'] = $item['id'];

                                $classes = array('tab-pane fade');

                                if (isset($item['active']) && $item['active']) {
                                        $classes[] = 'active in';
                                }

                                $classes = implode(' ', $classes);
                                if (isset($paneOptions['class'])) {
                                        $paneOptions['class'] .= ' ' . $classes;
                                } else {
                                        $paneOptions['class'] = $classes;
                                }

                                $panes[] = CHtml::tag('div', $paneOptions, $content);
                                $i++; // increment the tab-index
                        }
                        $items[] = $item;
                }
                return $items;
        }
}