BaseListView::renderSection() - Code Metrics - Inspection of "fixed docs for #12928" - rob006/yii2-dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 940f7c...e69234 )

by Robert

created 2016-11-10 22:24 UTC

BaseListView::renderSection() B

↳ Parent: BaseListView

Complexity

Conditions	5
Paths	5

Size

Total Lines	15
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5.3906

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	9
cts	12
cp	0.75
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	12
nc	5
nop	1
crap	5.3906

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

namespace yii\widgets;

use Yii;
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;

/**
 * BaseListView is a base class for widgets displaying data from data provider
 * such as ListView and GridView.
 *
 * It provides features like sorting, paging and also filtering the data.
 *
 * For more details and usage information on BaseListView, see the [guide article on data widgets](guide:output-data-widgets).
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
abstract class BaseListView extends Widget
{
    /**
     * @var array the HTML attributes for the container tag of the list 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 = [];
    /**
     * @var \yii\data\DataProviderInterface the data provider for the view. This property is required.
     */
    public $dataProvider;
    /**
     * @var array the configuration for the pager widget. By default, [[LinkPager]] will be
     * used to render the pager. You can use a different widget class by configuring the "class" element.
     * Note that the widget must support the `pagination` property which will be populated with the
     * [[\yii\data\BaseDataProvider::pagination|pagination]] value of the [[dataProvider]].
     */
    public $pager = [];
    /**
     * @var array the configuration for the sorter widget. By default, [[LinkSorter]] will be
     * used to render the sorter. You can use a different widget class by configuring the "class" element.
     * Note that the widget must support the `sort` property which will be populated with the
     * [[\yii\data\BaseDataProvider::sort|sort]] value of the [[dataProvider]].
     */
    public $sorter = [];
    /**
     * @var string the HTML content to be displayed as the summary of the list view.
     * If you do not want to show the summary, you may set it with an empty string.
     *
     * The following tokens will be replaced with the corresponding values:
     *
     * - `{begin}`: the starting row number (1-based) currently being displayed
     * - `{end}`: the ending row number (1-based) currently being displayed
     * - `{count}`: the number of rows currently being displayed
     * - `{totalCount}`: the total number of rows available
     * - `{page}`: the page number (1-based) current being displayed
     * - `{pageCount}`: the number of pages available
     */
    public $summary;
    /**
     * @var array the HTML attributes for the summary of the list view.
     * The "tag" element specifies the tag name of the summary element and defaults to "div".
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $summaryOptions = ['class' => 'summary'];
    /**
     * @var bool whether to show the list view if [[dataProvider]] returns no data.
     */
    public $showOnEmpty = false;
    /**
     * @var string the HTML content to be displayed when [[dataProvider]] does not have any data.
     */
    public $emptyText;
    /**
     * @var array the HTML attributes for the emptyText of the list view.
     * The "tag" element specifies the tag name of the emptyText element and defaults to "div".
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $emptyTextOptions = ['class' => 'empty'];
    /**
     * @var string the layout that determines how different sections of the list view should be organized.
     * The following tokens will be replaced with the corresponding section contents:
     *
     * - `{summary}`: the summary section. See [[renderSummary()]].
     * - `{items}`: the list items. See [[renderItems()]].
     * - `{sorter}`: the sorter. See [[renderSorter()]].
     * - `{pager}`: the pager. See [[renderPager()]].
     */
    public $layout = "{summary}\n{items}\n{pager}";


    /**
     * Renders the data models.
     * @return string the rendering result.
     */
    abstract public function renderItems();

    /**
     * Initializes the view.
     */
    public function init()
    {
        if ($this->dataProvider === null) {
            throw new InvalidConfigException('The "dataProvider" property must be set.');
        }
        if ($this->emptyText === null) {
            $this->emptyText = Yii::t('yii', 'No results found.');
        }
        if (!isset($this->options['id'])) {
            $this->options['id'] = $this->getId();
        }
    }

    /**
     * Runs the widget.
     */
    public function run()
    {
        if ($this->showOnEmpty || $this->dataProvider->getCount() > 0) {
            $content = preg_replace_callback("/{\\w+}/", function ($matches) {
                $content = $this->renderSection($matches[0]);

                return $content === false ? $matches[0] : $content;
            }, $this->layout);
        } else {
            $content = $this->renderEmpty();
        }

        $options = $this->options;
        $tag = ArrayHelper::remove($options, 'tag', 'div');
        echo Html::tag($tag, $content, $options);
    }

    /**
     * Renders a section of the specified name.
     * If the named section is not supported, false will be returned.
     * @param string $name the section name, e.g., `{summary}`, `{items}`.
     * @return string|bool the rendering result of the section, or false if the named section is not supported.
     */
    public function renderSection($name)
    {
        switch ($name) {
            case '{summary}':
                return $this->renderSummary();
            case '{items}':
                return $this->renderItems();
            case '{pager}':
                return $this->renderPager();
            case '{sorter}':
                return $this->renderSorter();
            default:
                return false;
        }
    }

    /**
     * Renders the HTML content indicating that the list view has no data.
     * @return string the rendering result
     * @see emptyText
     */
    public function renderEmpty()
    {
        $options = $this->emptyTextOptions;
        $tag = ArrayHelper::remove($options, 'tag', 'div');
        return Html::tag($tag, $this->emptyText, $options);
    }

    /**
     * Renders the summary text.
     */
    public function renderSummary()
    {
        $count = $this->dataProvider->getCount();
        if ($count <= 0) {
            return '';
        }
        $summaryOptions = $this->summaryOptions;
        $tag = ArrayHelper::remove($summaryOptions, 'tag', 'div');
        if (($pagination = $this->dataProvider->getPagination()) !== false) {
            $totalCount = $this->dataProvider->getTotalCount();
            $begin = $pagination->getPage() * $pagination->pageSize + 1;
            $end = $begin + $count - 1;
            if ($begin > $end) {
                $begin = $end;
            }
            $page = $pagination->getPage() + 1;
            $pageCount = $pagination->pageCount;
            if (($summaryContent = $this->summary) === null) {
                return Html::tag($tag, Yii::t('yii', 'Showing <b>{begin, number}-{end, number}</b> of <b>{totalCount, number}</b> {totalCount, plural, one{item} other{items}}.', [
                        'begin' => $begin,
                        'end' => $end,
                        'count' => $count,
                        'totalCount' => $totalCount,
                        'page' => $page,
                        'pageCount' => $pageCount,
                    ]), $summaryOptions);
            }
        } else {
            $begin = $page = $pageCount = 1;
            $end = $totalCount = $count;
            if (($summaryContent = $this->summary) === null) {
                return Html::tag($tag, Yii::t('yii', 'Total <b>{count, number}</b> {count, plural, one{item} other{items}}.', [
                    'begin' => $begin,
                    'end' => $end,
                    'count' => $count,
                    'totalCount' => $totalCount,
                    'page' => $page,
                    'pageCount' => $pageCount,
                ]), $summaryOptions);
            }
        }

        return Yii::$app->getI18n()->format($summaryContent, [
            'begin' => $begin,
            'end' => $end,
            'count' => $count,
            'totalCount' => $totalCount,
            'page' => $page,
            'pageCount' => $pageCount,
        ], Yii::$app->language);
    }

    /**
     * Renders the pager.
     * @return string the rendering result
     */
    public function renderPager()
    {
        $pagination = $this->dataProvider->getPagination();
        if ($pagination === false || $this->dataProvider->getCount() <= 0) {
            return '';
        }
        /* @var $class LinkPager */
        $pager = $this->pager;
        $class = ArrayHelper::remove($pager, 'class', LinkPager::className());
        $pager['pagination'] = $pagination;
        $pager['view'] = $this->getView();

        return $class::widget($pager);
    }

    /**
     * Renders the sorter.
     * @return string the rendering result
     */
    public function renderSorter()
    {
        $sort = $this->dataProvider->getSort();
        if ($sort === false || empty($sort->attributes) || $this->dataProvider->getCount() <= 0) {
            return '';
        }
        /* @var $class LinkSorter */
        $sorter = $this->sorter;
        $class = ArrayHelper::remove($sorter, 'class', LinkSorter::className());
        $sorter['sort'] = $sort;
        $sorter['view'] = $this->getView();

        return $class::widget($sorter);
    }
}


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\widgets;
9
10		use Yii;
11		use yii\base\InvalidConfigException;
12		use yii\base\Widget;
13		use yii\helpers\ArrayHelper;
14		use yii\helpers\Html;
15
16		/**
17		* BaseListView is a base class for widgets displaying data from data provider
18		* such as ListView and GridView.
19		*
20		* It provides features like sorting, paging and also filtering the data.
21		*
22		* For more details and usage information on BaseListView, see the [guide article on data widgets](guide:output-data-widgets).
23		*
24		* @author Qiang Xue <[email protected]>
25		* @since 2.0
26		*/
27		abstract class BaseListView extends Widget
28		{
29		/**
30		* @var array the HTML attributes for the container tag of the list view.
31		* The "tag" element specifies the tag name of the container element and defaults to "div".
32		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
33		*/
34		public $options = [];
35		/**
36		* @var \yii\data\DataProviderInterface the data provider for the view. This property is required.
37		*/
38		public $dataProvider;
39		/**
40		* @var array the configuration for the pager widget. By default, [[LinkPager]] will be
41		* used to render the pager. You can use a different widget class by configuring the "class" element.
42		* Note that the widget must support the `pagination` property which will be populated with the
43		* [[\yii\data\BaseDataProvider::pagination\|pagination]] value of the [[dataProvider]].
44		*/
45		public $pager = [];
46		/**
47		* @var array the configuration for the sorter widget. By default, [[LinkSorter]] will be
48		* used to render the sorter. You can use a different widget class by configuring the "class" element.
49		* Note that the widget must support the `sort` property which will be populated with the
50		* [[\yii\data\BaseDataProvider::sort\|sort]] value of the [[dataProvider]].
51		*/
52		public $sorter = [];
53		/**
54		* @var string the HTML content to be displayed as the summary of the list view.
55		* If you do not want to show the summary, you may set it with an empty string.
56		*
57		* The following tokens will be replaced with the corresponding values:
58		*
59		* - `{begin}`: the starting row number (1-based) currently being displayed
60		* - `{end}`: the ending row number (1-based) currently being displayed
61		* - `{count}`: the number of rows currently being displayed
62		* - `{totalCount}`: the total number of rows available
63		* - `{page}`: the page number (1-based) current being displayed
64		* - `{pageCount}`: the number of pages available
65		*/
66		public $summary;
67		/**
68		* @var array the HTML attributes for the summary of the list view.
69		* The "tag" element specifies the tag name of the summary element and defaults to "div".
70		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
71		*/
72		public $summaryOptions = ['class' => 'summary'];
73		/**
74		* @var bool whether to show the list view if [[dataProvider]] returns no data.
75		*/
76		public $showOnEmpty = false;
77		/**
78		* @var string the HTML content to be displayed when [[dataProvider]] does not have any data.
79		*/
80		public $emptyText;
81		/**
82		* @var array the HTML attributes for the emptyText of the list view.
83		* The "tag" element specifies the tag name of the emptyText element and defaults to "div".
84		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
85		*/
86		public $emptyTextOptions = ['class' => 'empty'];
87		/**
88		* @var string the layout that determines how different sections of the list view should be organized.
89		* The following tokens will be replaced with the corresponding section contents:
90		*
91		* - `{summary}`: the summary section. See [[renderSummary()]].
92		* - `{items}`: the list items. See [[renderItems()]].
93		* - `{sorter}`: the sorter. See [[renderSorter()]].
94		* - `{pager}`: the pager. See [[renderPager()]].
95		*/
96		public $layout = "{summary}\n{items}\n{pager}";
97
98
99		/**
100		* Renders the data models.
101		* @return string the rendering result.
102		*/
103		abstract public function renderItems();
104
105		/**
106		* Initializes the view.
107		*/
108	16	public function init()
109		{
110	16	if ($this->dataProvider === null) {
111		throw new InvalidConfigException('The "dataProvider" property must be set.');
112		}
113	16	if ($this->emptyText === null) {
114	16	$this->emptyText = Yii::t('yii', 'No results found.');
115	16	}
116	16	if (!isset($this->options['id'])) {
117	16	$this->options['id'] = $this->getId();
118	16	}
119	16	}
120
121		/**
122		* Runs the widget.
123		*/
124	9	public function run()
125		{
126	9	if ($this->showOnEmpty \|\| $this->dataProvider->getCount() > 0) {
127	9	$content = preg_replace_callback("/{\\w+}/", function ($matches) {
128	9	$content = $this->renderSection($matches[0]);
129
130	9	return $content === false ? $matches[0] : $content;
131	9	}, $this->layout);
132	9	} else {
133		$content = $this->renderEmpty();
134		}
135
136	9	$options = $this->options;
137	9	$tag = ArrayHelper::remove($options, 'tag', 'div');
138	9	echo Html::tag($tag, $content, $options);
139	9	}
140
141		/**
142		* Renders a section of the specified name.
143		* If the named section is not supported, false will be returned.
144		* @param string $name the section name, e.g., `{summary}`, `{items}`.
145		* @return string\|bool the rendering result of the section, or false if the named section is not supported.
146		*/
147	9	public function renderSection($name)
148		{
149		switch ($name) {
150	9	case '{summary}':
151	7	return $this->renderSummary();
152	9	case '{items}':
153	7	return $this->renderItems();
154	9	case '{pager}':
155	7	return $this->renderPager();
156	2	case '{sorter}':
157	2	return $this->renderSorter();
158		default:
159		return false;
160		}
161		}
162
163		/**
164		* Renders the HTML content indicating that the list view has no data.
165		* @return string the rendering result
166		* @see emptyText
167		*/
168		public function renderEmpty()
169		{
170		$options = $this->emptyTextOptions;
171		$tag = ArrayHelper::remove($options, 'tag', 'div');
172		return Html::tag($tag, $this->emptyText, $options);
173		}
174
175		/**
176		* Renders the summary text.
177		*/
178	7	public function renderSummary()
179		{
180	7	$count = $this->dataProvider->getCount();
181	7	if ($count <= 0) {
182		return '';
183		}
184	7	$summaryOptions = $this->summaryOptions;
185	7	$tag = ArrayHelper::remove($summaryOptions, 'tag', 'div');
186	7	if (($pagination = $this->dataProvider->getPagination()) !== false) {
187	7	$totalCount = $this->dataProvider->getTotalCount();
188	7	$begin = $pagination->getPage() * $pagination->pageSize + 1;
189	7	$end = $begin + $count - 1;
190	7	if ($begin > $end) {
191		$begin = $end;
192		}
193	7	$page = $pagination->getPage() + 1;
194	7	$pageCount = $pagination->pageCount;
195	7	if (($summaryContent = $this->summary) === null) {
196	7	return Html::tag($tag, Yii::t('yii', 'Showing <b>{begin, number}-{end, number}</b> of <b>{totalCount, number}</b> {totalCount, plural, one{item} other{items}}.', [
197	7	'begin' => $begin,
198	7	'end' => $end,
199	7	'count' => $count,
200	7	'totalCount' => $totalCount,
201	7	'page' => $page,
202	7	'pageCount' => $pageCount,
203	7	]), $summaryOptions);
204		}
205		} else {
206		$begin = $page = $pageCount = 1;
207		$end = $totalCount = $count;
208		if (($summaryContent = $this->summary) === null) {
209		return Html::tag($tag, Yii::t('yii', 'Total <b>{count, number}</b> {count, plural, one{item} other{items}}.', [
210		'begin' => $begin,
211		'end' => $end,
212		'count' => $count,
213		'totalCount' => $totalCount,
214		'page' => $page,
215		'pageCount' => $pageCount,
216		]), $summaryOptions);
217		}
218		}
219
220		return Yii::$app->getI18n()->format($summaryContent, [
221		'begin' => $begin,
222		'end' => $end,
223		'count' => $count,
224		'totalCount' => $totalCount,
225		'page' => $page,
226		'pageCount' => $pageCount,
227		], Yii::$app->language);
228		}
229
230		/**
231		* Renders the pager.
232		* @return string the rendering result
233		*/
234	7	public function renderPager()
235		{
236	7	$pagination = $this->dataProvider->getPagination();
237	7	if ($pagination === false \|\| $this->dataProvider->getCount() <= 0) {
238		return '';
239		}
240		/* @var $class LinkPager */
241	7	$pager = $this->pager;
242	7	$class = ArrayHelper::remove($pager, 'class', LinkPager::className());
243	7	$pager['pagination'] = $pagination;
244	7	$pager['view'] = $this->getView();
245
246	7	return $class::widget($pager);
247		}
248
249		/**
250		* Renders the sorter.
251		* @return string the rendering result
252		*/
253	2	public function renderSorter()
254		{
255	2	$sort = $this->dataProvider->getSort();
256	2	if ($sort === false \|\| empty($sort->attributes) \|\| $this->dataProvider->getCount() <= 0) {
257		return '';
258		}
259		/* @var $class LinkSorter */
260	2	$sorter = $this->sorter;
261	2	$class = ArrayHelper::remove($sorter, 'class', LinkSorter::className());
262	2	$sorter['sort'] = $sort;
263	2	$sorter['view'] = $this->getView();
264
265	2	return $class::widget($sorter);
266		}
267		}
268

rob006 / yii2-dev

GitHub Access Token became invalid

Push — master ( 940f7c...e69234 )

BaseListView::renderSection() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like