GridView::renderColumnGroup() - Code Metrics - Inspection of "Fixed tests for HHVM (#14941)" - rob006/yii2-dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f9fd4d...f5c98f )

by Robert

created 2017-10-07 18:57 UTC

GridView::renderColumnGroup() A

↳ Parent: GridView

Complexity

Conditions	4
Paths	4

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	4.8437

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	5
cts	8
cp	0.625
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	4
nop	0
crap	4.8437

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\grid;

use Closure;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Model;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\helpers\Url;
use yii\i18n\Formatter;
use yii\widgets\BaseListView;

/**
 * The GridView widget is used to display data in a grid.
 *
 * It provides features like [[sorter|sorting]], [[pager|paging]] and also [[filterModel|filtering]] the data.
 *
 * A basic usage looks like the following:
 *
 * ```php
 * <?= GridView::widget([
 *     'dataProvider' => $dataProvider,
 *     'columns' => [
 *         'id',
 *         'name',
 *         'created_at:datetime',
 *         // ...
 *     ],
 * ]) ?>
 * ```
 *
 * The columns of the grid table are configured in terms of [[Column]] classes,
 * which are configured via [[columns]].
 *
 * The look and feel of a grid view can be customized using the large amount of properties.
 *
 * For more details and usage information on GridView, see the [guide article on data widgets](guide:output-data-widgets).
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class GridView extends BaseListView
{
    const FILTER_POS_HEADER = 'header';
    const FILTER_POS_FOOTER = 'footer';
    const FILTER_POS_BODY = 'body';

    /**
     * @var string the default data column class if the class name is not explicitly specified when configuring a data column.
     * Defaults to 'yii\grid\DataColumn'.
     */
    public $dataColumnClass;
    /**
     * @var string the caption of the grid table
     * @see captionOptions
     */
    public $caption;
    /**
     * @var array the HTML attributes for the caption element.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     * @see caption
     */
    public $captionOptions = [];
    /**
     * @var array the HTML attributes for the grid table element.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $tableOptions = ['class' => 'table table-striped table-bordered'];
    /**
     * @var array the HTML attributes for the container tag of the grid view.
     * The "tag" element specifies the tag name of the container element and defaults to "div".
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $options = ['class' => 'grid-view'];
    /**
     * @var array the HTML attributes for the table header row.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $headerRowOptions = [];
    /**
     * @var array the HTML attributes for the table footer row.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $footerRowOptions = [];
    /**
     * @var array|Closure the HTML attributes for the table body rows. This can be either an array
     * specifying the common HTML attributes for all body rows, or an anonymous function that
     * returns an array of the HTML attributes. The anonymous function will be called once for every
     * data model returned by [[dataProvider]]. It should have the following signature:
     *
     * ```php
     * function ($model, $key, $index, $grid)
     * ```
     *
     * - `$model`: the current data model being rendered
     * - `$key`: the key value associated with the current data model
     * - `$index`: the zero-based index of the data model in the model array returned by [[dataProvider]]
     * - `$grid`: the GridView object
     *
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $rowOptions = [];
    /**
     * @var Closure an anonymous function that is called once BEFORE rendering each data model.
     * It should have the similar signature as [[rowOptions]]. The return result of the function
     * will be rendered directly.
     */
    public $beforeRow;
    /**
     * @var Closure an anonymous function that is called once AFTER rendering each data model.
     * It should have the similar signature as [[rowOptions]]. The return result of the function
     * will be rendered directly.
     */
    public $afterRow;
    /**
     * @var bool whether to show the header section of the grid table.
     */
    public $showHeader = true;
    /**
     * @var bool whether to show the footer section of the grid table.
     */
    public $showFooter = false;
    /**
     * @var bool whether to show the grid view if [[dataProvider]] returns no data.
     */
    public $showOnEmpty = true;
    /**
     * @var array|Formatter the formatter used to format model attribute values into displayable texts.
     * This can be either an instance of [[Formatter]] or an configuration array for creating the [[Formatter]]
     * instance. If this property is not set, the "formatter" application component will be used.
     */
    public $formatter;
    /**
     * @var array grid column configuration. Each array element represents the configuration
     * for one particular grid column. For example,
     *
     * ```php
     * [
     *     ['class' => SerialColumn::className()],
     *     [
     *         'class' => DataColumn::className(), // this line is optional
     *         'attribute' => 'name',
     *         'format' => 'text',
     *         'label' => 'Name',
     *     ],
     *     ['class' => CheckboxColumn::className()],
     * ]
     * ```
     *
     * If a column is of class [[DataColumn]], the "class" element can be omitted.
     *
     * As a shortcut format, a string may be used to specify the configuration of a data column
     * which only contains [[DataColumn::attribute|attribute]], [[DataColumn::format|format]],
     * and/or [[DataColumn::label|label]] options: `"attribute:format:label"`.
     * For example, the above "name" column can also be specified as: `"name:text:Name"`.
     * Both "format" and "label" are optional. They will take default values if absent.
     *
     * Using the shortcut format the configuration for columns in simple cases would look like this:
     *
     * ```php
     * [
     *     'id',
     *     'amount:currency:Total Amount',
     *     'created_at:datetime',
     * ]
     * ```
     *
     * When using a [[dataProvider]] with active records, you can also display values from related records,
     * e.g. the `name` attribute of the `author` relation:
     *
     * ```php
     * // shortcut syntax
     * 'author.name',
     * // full syntax
     * [
     *     'attribute' => 'author.name',
     *     // ...
     * ]
     * ```
     */
    public $columns = [];
    /**
     * @var string the HTML display when the content of a cell is empty.
     * This property is used to render cells that have no defined content,
     * e.g. empty footer or filter cells.
     *
     * Note that this is not used by the [[DataColumn]] if a data item is `null`. In that case
     * the [[\yii\i18n\Formatter::nullDisplay|nullDisplay]] property of the [[formatter]] will
     * be used to indicate an empty data value.
     */
    public $emptyCell = '&nbsp;';
    /**
     * @var \yii\base\Model the model that keeps the user-entered filter data. When this property is set,
     * the grid view will enable column-based filtering. Each data column by default will display a text field
     * at the top that users can fill in to filter the data.
     *
     * Note that in order to show an input field for filtering, a column must have its [[DataColumn::attribute]]
     * property set and the attribute should be active in the current scenario of $filterModel or have
     * [[DataColumn::filter]] set as the HTML code for the input field.
     *
     * When this property is not set (null) the filtering feature is disabled.
     */
    public $filterModel;
    /**
     * @var string|array the URL for returning the filtering result. [[Url::to()]] will be called to
     * normalize the URL. If not set, the current controller action will be used.
     * When the user makes change to any filter input, the current filtering inputs will be appended
     * as GET parameters to this URL.
     */
    public $filterUrl;
    /**
     * @var string additional jQuery selector for selecting filter input fields
     */
    public $filterSelector;
    /**
     * @var string whether the filters should be displayed in the grid view. Valid values include:
     *
     * - [[FILTER_POS_HEADER]]: the filters will be displayed on top of each column's header cell.
     * - [[FILTER_POS_BODY]]: the filters will be displayed right below each column's header cell.
     * - [[FILTER_POS_FOOTER]]: the filters will be displayed below each column's footer cell.
     */
    public $filterPosition = self::FILTER_POS_BODY;
    /**
     * @var array the HTML attributes for the filter row element.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $filterRowOptions = ['class' => 'filters'];
    /**
     * @var array the options for rendering the filter error summary.
     * Please refer to [[Html::errorSummary()]] for more details about how to specify the options.
     * @see renderErrors()
     */
    public $filterErrorSummaryOptions = ['class' => 'error-summary'];
    /**
     * @var array the options for rendering every filter error message.
     * This is mainly used by [[Html::error()]] when rendering an error message next to every filter input field.
     */
    public $filterErrorOptions = ['class' => 'help-block'];
    /**
     * @var string the layout that determines how different sections of the grid view should be organized.
     * The following tokens will be replaced with the corresponding section contents:
     *
     * - `{summary}`: the summary section. See [[renderSummary()]].
     * - `{errors}`: the filter model error summary. See [[renderErrors()]].
     * - `{items}`: the list items. See [[renderItems()]].
     * - `{sorter}`: the sorter. See [[renderSorter()]].
     * - `{pager}`: the pager. See [[renderPager()]].
     */
    public $layout = "{summary}\n{items}\n{pager}";


    /**
     * Initializes the grid view.
     * This method will initialize required property values and instantiate [[columns]] objects.
     */
    public function init()
    {
        parent::init();
        if ($this->formatter === null) {
            $this->formatter = Yii::$app->getFormatter();
        } elseif (is_array($this->formatter)) {
            $this->formatter = Yii::createObject($this->formatter);
        }
        if (!$this->formatter instanceof Formatter) {
            throw new InvalidConfigException('The "formatter" property must be either a Format object or a configuration array.');
        }
        if (!isset($this->filterRowOptions['id'])) {
            $this->filterRowOptions['id'] = $this->options['id'] . '-filters';
        }

        $this->initColumns();
    }

    /**
     * Runs the widget.
     */
    public function run()
    {
        $id = $this->options['id'];
        $options = Json::htmlEncode($this->getClientOptions());
        $view = $this->getView();
        GridViewAsset::register($view);
        $view->registerJs("jQuery('#$id').yiiGridView($options);");
        parent::run();
    }

    /**
     * Renders validator errors of filter model.
     * @return string the rendering result.
     */
    public function renderErrors()
    {
        if ($this->filterModel instanceof Model && $this->filterModel->hasErrors()) {
            return Html::errorSummary($this->filterModel, $this->filterErrorSummaryOptions);
        }

        return '';
    }

    /**
     * @inheritdoc
     */
    public function renderSection($name)
    {
        switch ($name) {
            case '{errors}':
                return $this->renderErrors();
            default:
                return parent::renderSection($name);
        }
    }

    /**
     * Returns the options for the grid view JS widget.
     * @return array the options
     */
    protected function getClientOptions()
    {
        $filterUrl = isset($this->filterUrl) ? $this->filterUrl : Yii::$app->request->url;
        $id = $this->filterRowOptions['id'];
        $filterSelector = "#$id input, #$id select";
        if (isset($this->filterSelector)) {
            $filterSelector .= ', ' . $this->filterSelector;
        }

        return [
            'filterUrl' => Url::to($filterUrl),
            'filterSelector' => $filterSelector,
        ];
    }

    /**
     * Renders the data models for the grid view.
     */
    public function renderItems()
    {
        $caption = $this->renderCaption();
        $columnGroup = $this->renderColumnGroup();
        $tableHeader = $this->showHeader ? $this->renderTableHeader() : false;
        $tableBody = $this->renderTableBody();
        $tableFooter = $this->showFooter ? $this->renderTableFooter() : false;
        $content = array_filter([
            $caption,
            $columnGroup,
            $tableHeader,
            $tableFooter,
            $tableBody,
        ]);

        return Html::tag('table', implode("\n", $content), $this->tableOptions);
    }

    /**
     * Renders the caption element.
     * @return bool|string the rendered caption element or `false` if no caption element should be rendered.
     */
    public function renderCaption()
    {
        if (!empty($this->caption)) {
            return Html::tag('caption', $this->caption, $this->captionOptions);
        }

        return false;
    }

    /**
     * Renders the column group HTML.
     * @return bool|string the column group HTML or `false` if no column group should be rendered.
     */
    public function renderColumnGroup()
    {
        foreach ($this->columns as $column) {
            /* @var $column Column */
            if (!empty($column->options)) {
                $cols = [];
                foreach ($this->columns as $col) {
                    $cols[] = Html::tag('col', '', $col->options);
                }

                return Html::tag('colgroup', implode("\n", $cols));
            }
        }

        return false;
    }

    /**
     * Renders the table header.
     * @return string the rendering result.
     */
    public function renderTableHeader()
    {
        $cells = [];
        foreach ($this->columns as $column) {
            /* @var $column Column */
            $cells[] = $column->renderHeaderCell();
        }
        $content = Html::tag('tr', implode('', $cells), $this->headerRowOptions);
        if ($this->filterPosition === self::FILTER_POS_HEADER) {
            $content = $this->renderFilters() . $content;
        } elseif ($this->filterPosition === self::FILTER_POS_BODY) {
            $content .= $this->renderFilters();
        }

        return "<thead>\n" . $content . "\n</thead>";
    }

    /**
     * Renders the table footer.
     * @return string the rendering result.
     */
    public function renderTableFooter()
    {
        $cells = [];
        foreach ($this->columns as $column) {
            /* @var $column Column */
            $cells[] = $column->renderFooterCell();
        }
        $content = Html::tag('tr', implode('', $cells), $this->footerRowOptions);
        if ($this->filterPosition === self::FILTER_POS_FOOTER) {
            $content .= $this->renderFilters();
        }

        return "<tfoot>\n" . $content . "\n</tfoot>";
    }

    /**
     * Renders the filter.
     * @return string the rendering result.
     */
    public function renderFilters()
    {
        if ($this->filterModel !== null) {
            $cells = [];
            foreach ($this->columns as $column) {
                /* @var $column Column */
                $cells[] = $column->renderFilterCell();
            }

            return Html::tag('tr', implode('', $cells), $this->filterRowOptions);
        }

        return '';
    }

    /**
     * Renders the table body.
     * @return string the rendering result.
     */
    public function renderTableBody()
    {
        $models = array_values($this->dataProvider->getModels());
        $keys = $this->dataProvider->getKeys();
        $rows = [];
        foreach ($models as $index => $model) {
            $key = $keys[$index];
            if ($this->beforeRow !== null) {
                $row = call_user_func($this->beforeRow, $model, $key, $index, $this);
                if (!empty($row)) {
                    $rows[] = $row;
                }
            }

            $rows[] = $this->renderTableRow($model, $key, $index);

            if ($this->afterRow !== null) {
                $row = call_user_func($this->afterRow, $model, $key, $index, $this);
                if (!empty($row)) {
                    $rows[] = $row;
                }
            }
        }

        if (empty($rows) && $this->emptyText !== false) {
            $colspan = count($this->columns);

            return "<tbody>\n<tr><td colspan=\"$colspan\">" . $this->renderEmpty() . "</td></tr>\n</tbody>";
        }

        return "<tbody>\n" . implode("\n", $rows) . "\n</tbody>";
    }

    /**
     * Renders a table row with the given data model and key.
     * @param mixed $model the data model to be rendered
     * @param mixed $key the key associated with the data model
     * @param int $index the zero-based index of the data model among the model array returned by [[dataProvider]].
     * @return string the rendering result
     */
    public function renderTableRow($model, $key, $index)
    {
        $cells = [];
        /* @var $column Column */
        foreach ($this->columns as $column) {
            $cells[] = $column->renderDataCell($model, $key, $index);
        }
        if ($this->rowOptions instanceof Closure) {
            $options = call_user_func($this->rowOptions, $model, $key, $index, $this);
        } else {
            $options = $this->rowOptions;
        }
        $options['data-key'] = is_array($key) ? json_encode($key) : (string) $key;

        return Html::tag('tr', implode('', $cells), $options);
    }

    /**
     * Creates column objects and initializes them.
     */
    protected function initColumns()
    {
        if (empty($this->columns)) {
            $this->guessColumns();
        }
        foreach ($this->columns as $i => $column) {
            if (is_string($column)) {
                $column = $this->createDataColumn($column);
            } else {
                $column = Yii::createObject(array_merge([
                    'class' => $this->dataColumnClass ?: DataColumn::className(),
                    'grid' => $this,
                ], $column));
            }
            if (!$column->visible) {
                unset($this->columns[$i]);
                continue;
            }
            $this->columns[$i] = $column;
        }
    }

    /**
     * Creates a [[DataColumn]] object based on a string in the format of "attribute:format:label".
     * @param string $text the column specification string
     * @return DataColumn the column instance
     * @throws InvalidConfigException if the column specification is invalid
     */
    protected function createDataColumn($text)
    {
        if (!preg_match('/^([^:]+)(:(\w*))?(:(.*))?$/', $text, $matches)) {
            throw new InvalidConfigException('The column must be specified in the format of "attribute", "attribute:format" or "attribute:format:label"');
        }

        return Yii::createObject([
            'class' => $this->dataColumnClass ?: DataColumn::className(),
            'grid' => $this,
            'attribute' => $matches[1],
            'format' => isset($matches[3]) ? $matches[3] : 'text',
            'label' => isset($matches[5]) ? $matches[5] : null,
        ]);
    }

    /**
     * This function tries to guess the columns to show from the given data
     * if [[columns]] are not explicitly specified.
     */
    protected function guessColumns()
    {
        $models = $this->dataProvider->getModels();
        $model = reset($models);
        if (is_array($model) || is_object($model)) {
            foreach ($model as $name => $value) {
                if ($value === null || is_scalar($value) || is_callable([$value, '__toString'])) {
                    $this->columns[] = (string) $name;
                }
            }
        }
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\grid;
9
10		use Closure;
11		use Yii;
12		use yii\base\InvalidConfigException;
13		use yii\base\Model;
14		use yii\helpers\Html;
15		use yii\helpers\Json;
16		use yii\helpers\Url;
17		use yii\i18n\Formatter;
18		use yii\widgets\BaseListView;
19
20		/**
21		* The GridView widget is used to display data in a grid.
22		*
23		* It provides features like [[sorter\|sorting]], [[pager\|paging]] and also [[filterModel\|filtering]] the data.
24		*
25		* A basic usage looks like the following:
26		*
27		* ```php
28		* <?= GridView::widget([
29		* 'dataProvider' => $dataProvider,
30		* 'columns' => [
31		* 'id',
32		* 'name',
33		* 'created_at:datetime',
34		* // ...
35		* ],
36		* ]) ?>
37		* ```
38		*
39		* The columns of the grid table are configured in terms of [[Column]] classes,
40		* which are configured via [[columns]].
41		*
42		* The look and feel of a grid view can be customized using the large amount of properties.
43		*
44		* For more details and usage information on GridView, see the [guide article on data widgets](guide:output-data-widgets).
45		*
46		* @author Qiang Xue <[email protected]>
47		* @since 2.0
48		*/
49		class GridView extends BaseListView
50		{
51		const FILTER_POS_HEADER = 'header';
52		const FILTER_POS_FOOTER = 'footer';
53		const FILTER_POS_BODY = 'body';
54
55		/**
56		* @var string the default data column class if the class name is not explicitly specified when configuring a data column.
57		* Defaults to 'yii\grid\DataColumn'.
58		*/
59		public $dataColumnClass;
60		/**
61		* @var string the caption of the grid table
62		* @see captionOptions
63		*/
64		public $caption;
65		/**
66		* @var array the HTML attributes for the caption element.
67		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
68		* @see caption
69		*/
70		public $captionOptions = [];
71		/**
72		* @var array the HTML attributes for the grid table element.
73		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
74		*/
75		public $tableOptions = ['class' => 'table table-striped table-bordered'];
76		/**
77		* @var array the HTML attributes for the container tag of the grid view.
78		* The "tag" element specifies the tag name of the container element and defaults to "div".
79		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
80		*/
81		public $options = ['class' => 'grid-view'];
82		/**
83		* @var array the HTML attributes for the table header row.
84		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
85		*/
86		public $headerRowOptions = [];
87		/**
88		* @var array the HTML attributes for the table footer row.
89		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
90		*/
91		public $footerRowOptions = [];
92		/**
93		* @var array\|Closure the HTML attributes for the table body rows. This can be either an array
94		* specifying the common HTML attributes for all body rows, or an anonymous function that
95		* returns an array of the HTML attributes. The anonymous function will be called once for every
96		* data model returned by [[dataProvider]]. It should have the following signature:
97		*
98		* ```php
99		* function ($model, $key, $index, $grid)
100		* ```
101		*
102		* - `$model`: the current data model being rendered
103		* - `$key`: the key value associated with the current data model
104		* - `$index`: the zero-based index of the data model in the model array returned by [[dataProvider]]
105		* - `$grid`: the GridView object
106		*
107		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
108		*/
109		public $rowOptions = [];
110		/**
111		* @var Closure an anonymous function that is called once BEFORE rendering each data model.
112		* It should have the similar signature as [[rowOptions]]. The return result of the function
113		* will be rendered directly.
114		*/
115		public $beforeRow;
116		/**
117		* @var Closure an anonymous function that is called once AFTER rendering each data model.
118		* It should have the similar signature as [[rowOptions]]. The return result of the function
119		* will be rendered directly.
120		*/
121		public $afterRow;
122		/**
123		* @var bool whether to show the header section of the grid table.
124		*/
125		public $showHeader = true;
126		/**
127		* @var bool whether to show the footer section of the grid table.
128		*/
129		public $showFooter = false;
130		/**
131		* @var bool whether to show the grid view if [[dataProvider]] returns no data.
132		*/
133		public $showOnEmpty = true;
134		/**
135		* @var array\|Formatter the formatter used to format model attribute values into displayable texts.
136		* This can be either an instance of [[Formatter]] or an configuration array for creating the [[Formatter]]
137		* instance. If this property is not set, the "formatter" application component will be used.
138		*/
139		public $formatter;
140		/**
141		* @var array grid column configuration. Each array element represents the configuration
142		* for one particular grid column. For example,
143		*
144		* ```php
145		* [
146		* ['class' => SerialColumn::className()],
147		* [
148		* 'class' => DataColumn::className(), // this line is optional
149		* 'attribute' => 'name',
150		* 'format' => 'text',
151		* 'label' => 'Name',
152		* ],
153		* ['class' => CheckboxColumn::className()],
154		* ]
155		* ```
156		*
157		* If a column is of class [[DataColumn]], the "class" element can be omitted.
158		*
159		* As a shortcut format, a string may be used to specify the configuration of a data column
160		* which only contains [[DataColumn::attribute\|attribute]], [[DataColumn::format\|format]],
161		* and/or [[DataColumn::label\|label]] options: `"attribute:format:label"`.
162		* For example, the above "name" column can also be specified as: `"name:text:Name"`.
163		* Both "format" and "label" are optional. They will take default values if absent.
164		*
165		* Using the shortcut format the configuration for columns in simple cases would look like this:
166		*
167		* ```php
168		* [
169		* 'id',
170		* 'amount:currency:Total Amount',
171		* 'created_at:datetime',
172		* ]
173		* ```
174		*
175		* When using a [[dataProvider]] with active records, you can also display values from related records,
176		* e.g. the `name` attribute of the `author` relation:
177		*
178		* ```php
179		* // shortcut syntax
180		* 'author.name',
181		* // full syntax
182		* [
183		* 'attribute' => 'author.name',
184		* // ...
185		* ]
186		* ```
187		*/
188		public $columns = [];
189		/**
190		* @var string the HTML display when the content of a cell is empty.
191		* This property is used to render cells that have no defined content,
192		* e.g. empty footer or filter cells.
193		*
194		* Note that this is not used by the [[DataColumn]] if a data item is `null`. In that case
195		* the [[\yii\i18n\Formatter::nullDisplay\|nullDisplay]] property of the [[formatter]] will
196		* be used to indicate an empty data value.
197		*/
198		public $emptyCell = ' ';
199		/**
200		* @var \yii\base\Model the model that keeps the user-entered filter data. When this property is set,
201		* the grid view will enable column-based filtering. Each data column by default will display a text field
202		* at the top that users can fill in to filter the data.
203		*
204		* Note that in order to show an input field for filtering, a column must have its [[DataColumn::attribute]]
205		* property set and the attribute should be active in the current scenario of $filterModel or have
206		* [[DataColumn::filter]] set as the HTML code for the input field.
207		*
208		* When this property is not set (null) the filtering feature is disabled.
209		*/
210		public $filterModel;
211		/**
212		* @var string\|array the URL for returning the filtering result. [[Url::to()]] will be called to
213		* normalize the URL. If not set, the current controller action will be used.
214		* When the user makes change to any filter input, the current filtering inputs will be appended
215		* as GET parameters to this URL.
216		*/
217		public $filterUrl;
218		/**
219		* @var string additional jQuery selector for selecting filter input fields
220		*/
221		public $filterSelector;
222		/**
223		* @var string whether the filters should be displayed in the grid view. Valid values include:
224		*
225		* - [[FILTER_POS_HEADER]]: the filters will be displayed on top of each column's header cell.
226		* - [[FILTER_POS_BODY]]: the filters will be displayed right below each column's header cell.
227		* - [[FILTER_POS_FOOTER]]: the filters will be displayed below each column's footer cell.
228		*/
229		public $filterPosition = self::FILTER_POS_BODY;
230		/**
231		* @var array the HTML attributes for the filter row element.
232		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
233		*/
234		public $filterRowOptions = ['class' => 'filters'];
235		/**
236		* @var array the options for rendering the filter error summary.
237		* Please refer to [[Html::errorSummary()]] for more details about how to specify the options.
238		* @see renderErrors()
239		*/
240		public $filterErrorSummaryOptions = ['class' => 'error-summary'];
241		/**
242		* @var array the options for rendering every filter error message.
243		* This is mainly used by [[Html::error()]] when rendering an error message next to every filter input field.
244		*/
245		public $filterErrorOptions = ['class' => 'help-block'];
246		/**
247		* @var string the layout that determines how different sections of the grid view should be organized.
248		* The following tokens will be replaced with the corresponding section contents:
249		*
250		* - `{summary}`: the summary section. See [[renderSummary()]].
251		* - `{errors}`: the filter model error summary. See [[renderErrors()]].
252		* - `{items}`: the list items. See [[renderItems()]].
253		* - `{sorter}`: the sorter. See [[renderSorter()]].
254		* - `{pager}`: the pager. See [[renderPager()]].
255		*/
256		public $layout = "{summary}\n{items}\n{pager}";
257
258
259		/**
260		* Initializes the grid view.
261		* This method will initialize required property values and instantiate [[columns]] objects.
262		*/
263	12	public function init()
264		{
265	12	parent::init();
266	12	if ($this->formatter === null) {
267	12	$this->formatter = Yii::$app->getFormatter();
268		} elseif (is_array($this->formatter)) {
269		$this->formatter = Yii::createObject($this->formatter);
270		}
271	12	if (!$this->formatter instanceof Formatter) {
272		throw new InvalidConfigException('The "formatter" property must be either a Format object or a configuration array.');
273		}
274	12	if (!isset($this->filterRowOptions['id'])) {
275	12	$this->filterRowOptions['id'] = $this->options['id'] . '-filters';
276		}
277
278	12	$this->initColumns();
279	12	}
280
281		/**
282		* Runs the widget.
283		*/
284	4	public function run()
285		{
286	4	$id = $this->options['id'];
287	4	$options = Json::htmlEncode($this->getClientOptions());
288	4	$view = $this->getView();
289	4	GridViewAsset::register($view);
290	4	$view->registerJs("jQuery('#$id').yiiGridView($options);");
291	4	parent::run();
292	4	}
293
294		/**
295		* Renders validator errors of filter model.
296		* @return string the rendering result.
297		*/
298		public function renderErrors()
299		{
300		if ($this->filterModel instanceof Model && $this->filterModel->hasErrors()) {
301		return Html::errorSummary($this->filterModel, $this->filterErrorSummaryOptions);
302		}
303
304		return '';
305		}
306
307		/**
308		* @inheritdoc
309		*/
310	4	public function renderSection($name)
311		{
312		switch ($name) {
313	4	case '{errors}':
314		return $this->renderErrors();
315		default:
316	4	return parent::renderSection($name);
317		}
318		}
319
320		/**
321		* Returns the options for the grid view JS widget.
322		* @return array the options
323		*/
324	4	protected function getClientOptions()
325		{
326	4	$filterUrl = isset($this->filterUrl) ? $this->filterUrl : Yii::$app->request->url;
327	4	$id = $this->filterRowOptions['id'];
328	4	$filterSelector = "#$id input, #$id select";
329	4	if (isset($this->filterSelector)) {
330		$filterSelector .= ', ' . $this->filterSelector;
331		}
332
333		return [
334	4	'filterUrl' => Url::to($filterUrl),
335	4	'filterSelector' => $filterSelector,
336		];
337		}
338
339		/**
340		* Renders the data models for the grid view.
341		*/
342	4	public function renderItems()
343		{
344	4	$caption = $this->renderCaption();
345	4	$columnGroup = $this->renderColumnGroup();
346	4	$tableHeader = $this->showHeader ? $this->renderTableHeader() : false;
347	4	$tableBody = $this->renderTableBody();
348	4	$tableFooter = $this->showFooter ? $this->renderTableFooter() : false;
349	4	$content = array_filter([
350	4	$caption,
351	4	$columnGroup,
352	4	$tableHeader,
353	4	$tableFooter,
354	4	$tableBody,
355		]);
356
357	4	return Html::tag('table', implode("\n", $content), $this->tableOptions);
358		}
359
360		/**
361		* Renders the caption element.
362		* @return bool\|string the rendered caption element or `false` if no caption element should be rendered.
363		*/
364	4	public function renderCaption()
365		{
366	4	if (!empty($this->caption)) {
367		return Html::tag('caption', $this->caption, $this->captionOptions);
368		}
369
370	4	return false;
371		}
372
373		/**
374		* Renders the column group HTML.
375		* @return bool\|string the column group HTML or `false` if no column group should be rendered.
376		*/
377	4	public function renderColumnGroup()
378		{
379	4	foreach ($this->columns as $column) {
380		/* @var $column Column */
381	1	if (!empty($column->options)) {
382		$cols = [];
383		foreach ($this->columns as $col) {
384		$cols[] = Html::tag('col', '', $col->options);
385		}
386
387	1	return Html::tag('colgroup', implode("\n", $cols));
388		}
389		}
390
391	4	return false;
392		}
393
394		/**
395		* Renders the table header.
396		* @return string the rendering result.
397		*/
398	1	public function renderTableHeader()
399		{
400	1	$cells = [];
401	1	foreach ($this->columns as $column) {
402		/* @var $column Column */
403	1	$cells[] = $column->renderHeaderCell();
404		}
405	1	$content = Html::tag('tr', implode('', $cells), $this->headerRowOptions);
406	1	if ($this->filterPosition === self::FILTER_POS_HEADER) {
407		$content = $this->renderFilters() . $content;
408	1	} elseif ($this->filterPosition === self::FILTER_POS_BODY) {
409	1	$content .= $this->renderFilters();
410		}
411
412	1	return "<thead>\n" . $content . "\n</thead>";
413		}
414
415		/**
416		* Renders the table footer.
417		* @return string the rendering result.
418		*/
419		public function renderTableFooter()
420		{
421		$cells = [];
422		foreach ($this->columns as $column) {
423		/* @var $column Column */
424		$cells[] = $column->renderFooterCell();
425		}
426		$content = Html::tag('tr', implode('', $cells), $this->footerRowOptions);
427		if ($this->filterPosition === self::FILTER_POS_FOOTER) {
428		$content .= $this->renderFilters();
429		}
430
431		return "<tfoot>\n" . $content . "\n</tfoot>";
432		}
433
434		/**
435		* Renders the filter.
436		* @return string the rendering result.
437		*/
438	1	public function renderFilters()
439		{
440	1	if ($this->filterModel !== null) {
441		$cells = [];
442		foreach ($this->columns as $column) {
443		/* @var $column Column */
444		$cells[] = $column->renderFilterCell();
445		}
446
447		return Html::tag('tr', implode('', $cells), $this->filterRowOptions);
448		}
449
450	1	return '';
451		}
452
453		/**
454		* Renders the table body.
455		* @return string the rendering result.
456		*/
457	4	public function renderTableBody()
458		{
459	4	$models = array_values($this->dataProvider->getModels());
460	4	$keys = $this->dataProvider->getKeys();
461	4	$rows = [];
462	4	foreach ($models as $index => $model) {
463	1	$key = $keys[$index];
464	1	if ($this->beforeRow !== null) {
465		$row = call_user_func($this->beforeRow, $model, $key, $index, $this);
466		if (!empty($row)) {
467		$rows[] = $row;
468		}
469		}
470
471	1	$rows[] = $this->renderTableRow($model, $key, $index);
472
473	1	if ($this->afterRow !== null) {
474		$row = call_user_func($this->afterRow, $model, $key, $index, $this);
475		if (!empty($row)) {
476	1	$rows[] = $row;
477		}
478		}
479		}
480
481	4	if (empty($rows) && $this->emptyText !== false) {
482	2	$colspan = count($this->columns);
483
484	2	return "<tbody>\n<tr><td colspan=\"$colspan\">" . $this->renderEmpty() . "</td></tr>\n</tbody>";
485		}
486
487	2	return "<tbody>\n" . implode("\n", $rows) . "\n</tbody>";
488		}
489
490		/**
491		* Renders a table row with the given data model and key.
492		* @param mixed $model the data model to be rendered
493		* @param mixed $key the key associated with the data model
494		* @param int $index the zero-based index of the data model among the model array returned by [[dataProvider]].
495		* @return string the rendering result
496		*/
497	1	public function renderTableRow($model, $key, $index)
498		{
499	1	$cells = [];
500		/* @var $column Column */
501	1	foreach ($this->columns as $column) {
502	1	$cells[] = $column->renderDataCell($model, $key, $index);
503		}
504	1	if ($this->rowOptions instanceof Closure) {
505		$options = call_user_func($this->rowOptions, $model, $key, $index, $this);
506		} else {
507	1	$options = $this->rowOptions;
508		}
509	1	$options['data-key'] = is_array($key) ? json_encode($key) : (string) $key;
510
511	1	return Html::tag('tr', implode('', $cells), $options);
512		}
513
514		/**
515		* Creates column objects and initializes them.
516		*/
517	12	protected function initColumns()
518		{
519	12	if (empty($this->columns)) {
520	6	$this->guessColumns();
521		}
522	12	foreach ($this->columns as $i => $column) {
523	7	if (is_string($column)) {
524	3	$column = $this->createDataColumn($column);
525		} else {
526	4	$column = Yii::createObject(array_merge([
527	4	'class' => $this->dataColumnClass ?: DataColumn::className(),
528	4	'grid' => $this,
529	4	], $column));
530		}
531	7	if (!$column->visible) {
532		unset($this->columns[$i]);
533		continue;
534		}
535	7	$this->columns[$i] = $column;
536		}
537	12	}
538
539		/**
540		* Creates a [[DataColumn]] object based on a string in the format of "attribute:format:label".
541		* @param string $text the column specification string
542		* @return DataColumn the column instance
543		* @throws InvalidConfigException if the column specification is invalid
544		*/
545	3	protected function createDataColumn($text)
546		{
547	3	if (!preg_match('/^([^:]+)(:(\w))?(:(.))?$/', $text, $matches)) {
548		throw new InvalidConfigException('The column must be specified in the format of "attribute", "attribute:format" or "attribute:format:label"');
549		}
550
551	3	return Yii::createObject([
552	3	'class' => $this->dataColumnClass ?: DataColumn::className(),
553	3	'grid' => $this,
554	3	'attribute' => $matches[1],
555	3	'format' => isset($matches[3]) ? $matches[3] : 'text',
556	3	'label' => isset($matches[5]) ? $matches[5] : null,
557		]);
558		}
559
560		/**
561		* This function tries to guess the columns to show from the given data
562		* if [[columns]] are not explicitly specified.
563		*/
564	6	protected function guessColumns()
565		{
566	6	$models = $this->dataProvider->getModels();
567	6	$model = reset($models);
568	6	if (is_array($model) \|\| is_object($model)) {
569	1	foreach ($model as $name => $value) {
570	1	if ($value === null \|\| is_scalar($value) \|\| is_callable([$value, '__toString'])) {
571	1	$this->columns[] = (string) $name;
572		}
573		}
574		}
575	6	}
576		}
577

rob006 / yii2-dev

GitHub Access Token became invalid

Push — master ( f9fd4d...f5c98f )

GridView::renderColumnGroup() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like