TbJsonGridView.php

Go to the documentation of this file.

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

class TbJsonGridView extends TbGridView
{
        public $json;

        public $template = "{pager}\n{items}\n{summary}\n{pager}";

        public $cacheTTL = 1;

        public $cacheTTLType = 's';

        public $localCache = true;

        public $pager = array('class' => 'booster.widgets.TbJsonPager');

        protected $_showSummary;

        public function init()
        {
                // parse request to find out whether is an ajax request or not, if so, then return $dataProvider JSON formatted
                $this->json = Yii::app()->getRequest()->getIsAjaxRequest();
                if ($this->json) {
                        $this->_showSummary = (strpos($this->template, '{summary}')) ? true : false;
                        $this->template = '{items}';
                } // going to render only items!

                parent::init();
        }

        public function run()
        {
                if (!$this->json) {
                        parent::run();
                } else {
                        $this->registerClientScript();
                        $this->renderContent();
                }
        }

        public function renderPager()
        {
                if (!$this->json) {
                        parent::renderPager();
                        return true;
                }

                $pager = array();
                if (is_string($this->pager)) {
                        $class = $this->pager;
                } else if (is_array($this->pager)) {
                        $pager = $this->pager;
                        if (isset($pager['class'])) {
                                $class = $pager['class'];
                                unset($pager['class']);
                        }
                }
                $pager['pages'] = $this->dataProvider->getPagination();

                if ($pager['pages']->getPageCount() > 1) {
                        $pager['json'] = $this->json;
                        $widget = $this->createWidget($class, $pager);

                        return $widget->run();
                } else {
                        return array();
                }
        }

        protected function initColumns()
        {
                foreach ($this->columns as $i => $column) {
                        if (is_array($column) && !isset($column['class'])) {
                                $this->columns[$i]['class'] = 'booster.widgets.TbJsonDataColumn';
                        }
                }

                parent::initColumns();
        }

        public function renderItems()
        {
                if ($this->json) {
                        echo function_exists('json_encode')
                                ? json_encode($this->renderTableBody())
                                : CJSON::encode(
                                        $this->renderTableBody()
                                );

                } elseif ($this->dataProvider->getItemCount() > 0 || $this->showTableOnEmpty) {
                        echo "<table class=\"{$this->itemsCssClass}\">\n";
                        $this->renderTableHeader();
                        ob_start();
                        $this->renderTableBody();
                        $body = ob_get_clean();
                        $this->renderTableFooter();
                        echo $body; // TFOOT must appear before TBODY according to the standard.
                        echo "</table>";
                        $this->renderTemplates();

                } else {
                        $this->renderEmptyText();
                }
        }

        public function renderSummary()
        {
                if (!$this->json)
                {
                        parent::renderSummary();
                        return true;
                }

                if (!$this->_showSummary)
                {
                        return null;
                }

                ob_start();
                parent::renderSummary();
                $summary = ob_get_clean();
                return array(
                        'class' => $this->summaryCssClass,
                        'text' => $summary
                );

        }
        protected function renderTemplates()
        {
                echo $this->renderTemplate($this->id . '-col-template', '<td <%=this.attrs%>><%=this.content%></td>');
                echo $this->renderTemplate(
                        $this->id . '-row-template',
                        '<tr class="<%=this.class%>"><% var t = "#' . $this->id . '-col-template"; out += $.jqote(t, this.cols);%></tr>'
                );
                echo $this->renderTemplate($this->id . '-keys-template', '<span><%=this%></span>');

                echo $this->renderTemplate(
                        $this->id . '-pager-template',
                        '<li class="<%=this.class%>"><a href="<%=this.url%>"><%=this.text%></a></li>'
                );

                echo $this->renderTemplate(
                        $this->id . '-summary-template',
                        '<div class="<%=this.class%>"><%=this.text%></div>'
                );

        }

        public function renderTemplate($id, $text)
        {
                return "<script type=\"text/x-jqote-template\" id=\"{$id}\">\n<![CDATA[\n{$text}\n]]>\n</script>";
        }

        public function renderTableBody()
        {
                $data = $this->dataProvider->getData();
                $n = count($data);

                if ($this->json) {
                        return $this->renderTableBodyJSON($n);
                }

                echo CHtml::openTag('tbody');

                if ($n > 0) {
                        for ($row = 0; $row < $n; ++$row) {
                                $this->renderTableRow($row);
                        }
                } else {
                        echo '<tr><td colspan="' . count($this->columns) . '" class="empty">';
                        $this->renderEmptyText();
                        echo "</td></tr>\n";
                }

                echo CHtml::closeTag('tbody');
        }

        protected function renderTableBodyJSON($rows)
        {
                $tbody = array(
                        'headers' => array(),
                        'rows' => array(),
                        'keys' => array(),
                        'summary' => array()
                );
                foreach ($this->columns as $column) {
                        // TODO: what is this?
                        // if (property_exists($column, 'json')) {
                                // $column->json = $this->json;
                                $tbody['headers'][] = $column->renderHeaderCell();
                        // }
                }

                if ($rows > 0) {
                        for ($row = 0; $row < $rows; ++$row) {
                                $tbody['rows'][] = $this->renderTableRowJSON($row);
                        }

                        foreach ($this->dataProvider->getKeys() as $key) {
                                $tbody['keys'][] = CHtml::encode($key);
                        }

                } else {
                        ob_start();
                        $this->renderEmptyText();
                        $content = ob_get_contents();
                        ob_end_clean();

                        $tbody['rows'][0]['cols'][] = array(
                                'attrs' => "colspan=\"" . count($this->columns) . "\"",
                                'content' => $content
                        );
                        $tbody['rows'][0]['class'] = " ";
                }
                $tbody['pager'] = $this->renderPager();
                $tbody['url'] = Yii::app()->getRequest()->getUrl();
                $tbody['summary'] = $this->renderSummary();
                return $tbody;
        }

        public function renderTableRow($row)
        {
                if ($this->rowCssClassExpression !== null) {
                        $data = $this->dataProvider->data[$row];
                        echo '<tr class="' . $this->evaluateExpression(
                                $this->rowCssClassExpression,
                                array('row' => $row, 'data' => $data)
                        ) . '">';
                } else if (is_array($this->rowCssClass) && ($n = count($this->rowCssClass)) > 0) {
                        echo '<tr class="' . $this->rowCssClass[$row % $n] . '">';
                } else {
                        echo '<tr>';
                }
                foreach ($this->columns as $column) {
                        $column->renderDataCell($row);
                }
                echo "</tr>\n";
        }

        protected function renderTableRowJSON($row)
        {
                $json = array();
                if ($this->rowCssClassExpression !== null) {
                        $data = $this->dataProvider->data[$row];
                        $json['class'] = $this->evaluateExpression(
                                $this->rowCssClassExpression,
                                array('row' => $row, 'data' => $data)
                        );
                } else if (is_array($this->rowCssClass) && ($n = count($this->rowCssClass)) > 0) {
                        $json['class'] = $this->rowCssClass[$row % $n];
                } else {
                        echo '<tr>';
                }
                foreach ($this->columns as $column) {
                        $json['cols'][] = $column->renderDataCell($row);
                }

                return $json;
        }

        protected function createDataColumn($text)
        {
                if (!preg_match('/^([\w\.]+)(:(\w*))?(:(.*))?$/', $text, $matches)) {
                        throw new CException(Yii::t(
                                'zii',
                                'The column must be specified in the format of "Name:Type:Label", where "Type" and "Label" are optional.'
                        ));
                }

                $column = new TbJsonDataColumn($this);
                $column->name = $matches[1];

                if (isset($matches[3]) && $matches[3] !== '') {
                        $column->type = $matches[3];
                }

                if (isset($matches[5])) {
                        $column->header = $matches[5];
                }

                return $column;
        }

        public function registerClientScript()
        {
                $id = $this->getId();

                if ($this->ajaxUpdate === false) {
                        $ajaxUpdate = false;
                } else {
                        $ajaxUpdate = array_unique(
                                preg_split('/\s*,\s*/', $this->ajaxUpdate . ',' . $id, -1, PREG_SPLIT_NO_EMPTY)
                        );
                }
                $options = array(
                        'ajaxUpdate' => $ajaxUpdate,
                        'ajaxVar' => $this->ajaxVar,
                        'pagerClass' => $this->pagerCssClass,
                        'summaryClass' => $this->summaryCssClass,
                        'loadingClass' => $this->loadingCssClass,
                        'filterClass' => $this->filterCssClass,
                        'tableClass' => $this->itemsCssClass,
                        'selectableRows' => $this->selectableRows,
                        'enableHistory' => $this->enableHistory,
                        'updateSelector' => $this->updateSelector,
                        'cacheTTL' => $this->cacheTTL,
                        'cacheTTLType' => $this->cacheTTLType,
                        'localCache' => $this->localCache
                );
                if ($this->ajaxUrl !== null) {
                        $options['url'] = CHtml::normalizeUrl($this->ajaxUrl);
                }
                if ($this->enablePagination) {
                        $options['pageVar'] = $this->dataProvider->getPagination()->pageVar;
                }

                foreach (array('beforeAjaxUpdate', 'afterAjaxUpdate', 'ajaxUpdateError', 'selectionChanged') as $prop) {
                        if ($this->{$prop} !== null) {
                                if ((!$this->{$prop} instanceof CJavaScriptExpression) && strpos($this->{$prop}, 'js:') !== 0) {
                                        $options[$prop] = new CJavaScriptExpression($this->{$prop});
                                } else {
                                        $options[$prop] = $this->{$prop};
                                }
                        }
                }

                $options = CJavaScript::encode($options);
                $cs = Yii::app()->getClientScript();
                $cs->registerCoreScript('jquery');
                $cs->registerCoreScript('bbq');
                if ($this->enableHistory) {
                        $cs->registerCoreScript('history');
                }

                $cs->registerPackage('json-grid-view');

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