goPaginator: отрисовка пагинатора

Начинаю раздел goLibs с выкладыванием простеньких вспомогательных классиков. Первым на очереди идёт goPaginator. Можно просмотреть исходный код или скачать ZIP.

Основная задача библиотеки — отрисовка пагинатора и помощь в выборки данных для текущей страницы. Простейший пример (более развёрнутый пример можно пощупать здесь):

/* Общее количество элементов в списке, разбиваемым на страницы */
$countElements = query('SELECT COUNT(*) FROM `table`');
if ($countElements == 0) {
	echo 'Список пуст';
	return;
}
 
$pager = new goPaginator($countElements); // Создаём объект пагинатора
 
echo $pager; // Выводим пагинатор сверху
 
/* Выборка и вывод элементов для текущей страницы */
$sql = 'SELECT * FROM `table` ORDER BY `id` ASC LIMIT '.$pager->getSqlLimits();
$elements = query($sql);
foreach ($elements as $element) { /* Выводим элементы */ }
 
echo $pager; // Пагинатор снизу

В простейшем случае номер текущей страницы берётся из GET-параметра page. Номера страниц в пагинаторе так же передаются через ?page=X. Если page не указан, считается, что это первая страница. Так же номер страницы приводится к допустимому диапазону (от 1 до ОбщегоКоличестваСтраниц).

Общий вид пагинатора: ← 1 2 3 ... 7 [8] 9 ... 15 16 17 →.

Расчёт и отрисовку пагинатора можно настраивать через параметры, полный список которых даётся в разделе список параметров.

Методы объекта goPaginator

echo $pager->draw(); // Отрисовать пагинатор
echo $pager;         // Аналогично

$sql = 'SELECT * FROM `table` ORDER BY `id` ASC LIMIT '.$pager->getSqlLimits();

Список параметров отрисовки

Параметры задаются через конструктор или setParam. Для не заданных параметров используется значение по умолчанию.

Формирование ссылок

По умолчанию ссылка берётся из GET-параметра page. Если он не указана, подразумевается первая страница. При формировании ссылок на страницы, номера так же вставляются в ?page=, кроме того сохраняются все остальные GET-параметры. Т.е. если пагинатор выводился на странице index.php?x=1&page=5&y=2, то ссылка на 3-ю страницу будет index.php?x=1&y=2&page=3.

Имя GET-параметра можно изменить с помощью параметра pageVar.

В более сложных случаях можно задействовать параметры urlPrefix и urlPostfix. Тогда ссылки будут иметь вид $urlPrefix.$page.$urlPostfix.

Допустим, у нас ЧПУ и не используются GET-параметры. А адрес страницы имеет вид /news/archive/$numberPage/.

 
$currentPage = getCurrentPage(); // Имя текущей страницы придётся определить самим.
$params = array(
	'currentPage' => $currentPage,
	'urlPrefix'   => '/news/archive/',
	'urlPostfix'  => '/',
);
$pager = new goPaginator($countElements, $params);
 
echo $pager;

Теперь ссылки будут формироваться так как нам нужно.

Для ещё более сложных случаев можно использовать перегрузку методов.

Вёрстка пагинатора

Оторажение пагинатора настраивается через CSS и параметры отображения.

Примерный вид вёрстки:

<div class="paginator">
	<span class="title">Страницы:</span>
	<span class="arr">&larr;</span>
	<span&gt;
		<span><a href="?page=1">1</a></span>
		<span class="current"><a href="?page=2">2</a></span>
		<span><a href="?page=3">3</a></span>
		<span class="space">...</span>
		<span><a href="?page=37">37</a></span>
		<span><a href="?page=38">38</a></span>
		<span><a href="?page=39">39</a></span>
	</span>
	<span class="arr"><a href="?page=2">&rarr;</a></span>
</div>

CSS-класс current указывает текущую страницу.

Параметры, которыми можно повлиять на вёрстку:

tag, css: тег и его CSS-класс в который заключается пагиантор. Если tag не указан, ни во что не заключается.

listtag, litag, теги в которые заключается весь блок списка страниц и каждая страница соответственно. В примере, они оба <span>. Как вариант, для более семантической вёрстки, можно заменить на <ul> и <li>.

Так же на вёрстку влияют title, arr, solid, line, space, asep. См. раздел параметры отображения.

Перегрузка методов

Все публичные методы помечены, как final, большинство остальных закрыты (private), как и свойства. Три метода помечены, как protected и с помощью их переопределения можно наследовать пагинаторы с более сложным поведением.

Некоторые замечания

Пагинатор не работает с пустыми списками. Если $countElements = 0, генерируется исключение.

Все установки (setParam(), setCountElements()) следует делать до отрисовки пагинатора и вызовов get*-методов, иначе установки не возымеют эффекта.

$pager = new goPaginator($count);
$pager->setParam('pageSize', 20);
echo $pager; // по 20 на странице
$pager->setParam('pageSize', 10); // ничего не даст
echo $pager; // всё равно по 20