BaseListView.php 6.47 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?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;

/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
20
abstract class BaseListView extends Widget
Qiang Xue committed
21 22 23 24 25
{
	/**
	 * @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".
	 */
Alexander Makarov committed
26
	public $options = [];
Qiang Xue committed
27
	/**
28
	 * @var \yii\data\DataProviderInterface the data provider for the view. This property is required.
Qiang Xue committed
29 30 31 32 33 34
	 */
	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.
	 */
Alexander Makarov committed
35
	public $pager = [];
Qiang Xue committed
36 37 38 39
	/**
	 * @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.
	 */
Alexander Makarov committed
40
	public $sorter = [];
Qiang Xue committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
	/**
	 * @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;
	/**
56
	 * @var boolean whether to show the list view if [[dataProvider]] returns no data.
Qiang Xue committed
57
	 */
58 59 60 61 62
	public $showOnEmpty = false;
	/**
	 * @var string the HTML content to be displayed when [[dataProvider]] does not have any data.
	 */
	public $emptyText;
Qiang Xue committed
63 64 65 66 67 68 69 70 71
	/**
	 * @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()]].
	 */
72
	public $layout = "{summary}\n{items}\n{pager}";
Qiang Xue committed
73 74 75


	/**
76
	 * Renders the data models.
Qiang Xue committed
77 78 79 80 81 82 83 84 85 86 87 88
	 * @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.');
		}
89 90 91
		if ($this->emptyText === null) {
			$this->emptyText = Yii::t('yii', 'No results found.');
		}
Qiang Xue committed
92
		$this->dataProvider->prepare();
Qiang Xue committed
93 94 95 96 97 98 99
	}

	/**
	 * Runs the widget.
	 */
	public function run()
	{
100
		if ($this->dataProvider->getCount() > 0 || $this->showOnEmpty) {
101
			$content = preg_replace_callback("/{\\w+}/", function ($matches) {
102
				$content = $this->renderSection($matches[0]);
Qiang Xue committed
103 104 105
				return $content === false ? $matches[0] : $content;
			}, $this->layout);
		} else {
106
			$content = $this->renderEmpty();
Qiang Xue committed
107 108 109 110 111 112 113 114 115 116 117
		}
		$tag = ArrayHelper::remove($this->options, 'tag', 'div');
		echo Html::tag($tag, $content, $this->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|boolean the rendering result of the section, or false if the named section is not supported.
	 */
118
	public function renderSection($name)
Qiang Xue committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
	{
		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;
		}
	}

134 135 136 137 138 139 140 141 142 143
	/**
	 * Renders the HTML content indicating that the list view has no data.
	 * @return string the rendering result
	 * @see emptyText
	 */
	public function renderEmpty()
	{
		return '<div class="empty">' . ($this->emptyText === null ? Yii::t('yii', 'No results found.') : $this->emptyText) . '</div>';
	}

Qiang Xue committed
144 145 146 147 148 149
	/**
	 * Renders the summary text.
	 */
	public function renderSummary()
	{
		$count = $this->dataProvider->getCount();
Qiang Xue committed
150 151 152
		if ($count <= 0) {
			return '';
		}
153
		if (($pagination = $this->dataProvider->getPagination()) !== false) {
Qiang Xue committed
154 155 156
			$totalCount = $this->dataProvider->getTotalCount();
			$begin = $pagination->getPage() * $pagination->pageSize + 1;
			$end = $begin + $count - 1;
157 158 159
			if ($begin > $end) {
				$begin = $end;
			}
Qiang Xue committed
160 161 162
			$page = $pagination->getPage() + 1;
			$pageCount = $pagination->pageCount;
			if (($summaryContent = $this->summary) === null) {
163
				$summaryContent = '<div class="summary">'
164
					. Yii::t('yii', 'Showing <b>{begin, number}-{end, number}</b> of <b>{totalCount, number}</b> {totalCount, plural, one{item} other{items}}.')
165
					. '</div>';
Qiang Xue committed
166 167 168 169 170
			}
		} else {
			$begin = $page = $pageCount = 1;
			$end = $totalCount = $count;
			if (($summaryContent = $this->summary) === null) {
171
				$summaryContent = '<div class="summary">' . Yii::t('yii', 'Total <b>{count, number}</b> {count, plural, one{item} other{items}}.') . '</div>';
Qiang Xue committed
172 173
			}
		}
174 175 176 177 178 179 180 181
		return Yii::$app->getI18n()->format($summaryContent, [
			'begin' => $begin,
			'end' => $end,
			'count' => $count,
			'totalCount' => $totalCount,
			'page' => $page,
			'pageCount' => $pageCount,
		], Yii::$app->language);
Qiang Xue committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
	}

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