Docs For Class sbDBPager

Описание

Класс, осуществляющий разбиение результатов SQL-запроса по страницам

Пример использования класса:

// в эту переменную запишется общее кол-во найденных записей
$total = true;
// вызываем конструктор класса, передавая ему в качестве параметров уникальный идентификатор (для формирования имени GET-параметра),
// максимальное кол-во номеров страниц в списке, максимальное кол-во записей на одной странице, target-атрибут, устанавливаемый для всех
// сформированных ссылок
$pager = new sbDBPager('sl', 7, 50, 'content');
// переменная $result получает результат работы SQL-запроса
$result = $pager->init($total, 'SELECT sl_date, sl_user_id, sl_user_login, sl_user_ip, sl_message, sl_type FROM sb_system_log '.$order.' WHERE sl_domain=?', SB_COOKIE_DOMAIN);
// переменная $num_list получает HTML-код для вывода номеров страниц
$num_list = $pager->show();

author: Казбек Елекоев <elekoev@binn.ru>
version: 4.0
copyright: Copyright (c) 2007, OOO "СИБИЭС Групп"

Располагается в /lib/sbDBPager.inc.php (строка 35)

Переменные (список)

string $mBeginTemp

string $mBeginTempDisabled

string $mCurNumberTemp

string $mEndTemp

string $mEndTempDisabled

int $mFrom

string $mListTemp

string $mNextTemp

string $mNextTempDisabled

string $mNumberTemp

int $mNumElemsAll

string $mPrevTemp

string $mPrevTempDisabled

int $mTo

Методы (список)

sbDBPager __construct (string $prefix, [int $num_pages = 7], [int $num_elems = 20], [string $target = ''])

mixed init ( &$total, int $total, string $query, mixed $arg1,..., string $message, int $type)

strign show ()

Переменные

string $mBeginTemp (строка 109)

Макет дизайна для вывода ссылки "Начало"

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mBeginTempDisabled (строка 123)

Макет дизайна для вывода неактивной ссылки "Начало"

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mCurNumberTemp = ' <b>{NUMBER}</b> ' (строка 180)

Макет дизайна для вывода ссылки на текущий номер страницы

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{NUMBER} - номер страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mEndTemp (строка 220)

Макет дизайна для вывода ссылки "Конец"

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mEndTempDisabled (строка 232)

Макет дизайна для вывода неактивной ссылки "Конец"

В макете дизайна доступны следующие псевдо-теги:

{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

int $mFrom = 0 (строка 75)

Начиная с какой записи делать выборку

access: public

string $mListTemp = '{BEGIN} {PREV} {LIST} {NEXT} {END}' (строка 249)

Макет дизайна для вывода списка ссылок

В макете дизайна доступны следующие псевдо-теги:

{BEGIN} - ссылка "Начало"
{PREV} - ссылка "Предыдущие
{LIST} - список номеров страниц
{NEXT} - ссылка "Следующие"
{END} - ссылка "Конец"
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mNextTemp (строка 194)

Макет дизайна для вывода ссылки "Следующие"

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mNextTempDisabled (строка 206)

Макет дизайна для вывода неактивной ссылки "Следующие"

В макете дизайна доступны следующие псевдо-теги:

{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mNumberTemp = ' <a href="{HREF}" target="{TARGET}">{NUMBER}</a> ' (строка 166)

Макет дизайна для вывода ссылки на номер страницы

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{NUMBER} - номер страницы
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

int $mNumElemsAll = 0 (строка 68)

Общее кол-во записей

Определяется в методе init, либо задается пользователем.

access: public

string $mPrevTemp (строка 137)

Макет дизайна для вывода ссылки "Предыдущие"

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

string $mPrevTempDisabled (строка 151)

Макет дизайна для вывода неактивной ссылки "Предыдущие"

В макете дизайна доступны следующие псевдо-теги:

{HREF} - заменяется на ссылку
{TARGET} - заменяется на target, указанный в конструкторе класса
{CUR_PAGE} - номер текущей страницы
{ALL_PAGES} - общее кол-во страниц
{ALL_ELEMS} - общее кол-во записей

access: public

int $mTo = 0 (строка 82)

До какой записи делать выборку

access: public

Методы

Конструктор __construct (строка 262)

Конструктор класса

В конструкторе класса определяется номер текущей страницы, если таковой был передан через GET-параметр.

sbDBPager __construct (string $prefix, [int $num_pages = 7], [int $num_elems = 20], [string $target = ''])

string $prefix: Уникальный идентификатор (используется для формирования имени GET-параметра, например, если передано значение 'news', то GET-параметр, через который передается номер текущей страницы, получит имя 'page_news').
int $num_pages: Максимальное кол-во номеров страниц в списке.
int $num_elems: Максимальное кол-во записей на одной странице.
string $target: target-атрибут, устанавливаемый для всех сформированных ссылок.

init (строка 300)

Запускает переданный SQL-запрос

В SQL-запросе не надо использовать структуру LIMIT. Параметру $total присваивается общее кол-во найденных записей.

return: Двумерный массив. FALSE в случае возникновения ошибки.
see: sbMySqli::paramQueryPage()
see: sbMySql::paramQueryPage()

mixed init ( &$total, int $total, string $query, mixed $arg1,..., string $message, int $type)

int $total: Получает общее кол-во найденных записей.
string $query: SQL-запрос.
mixed $arg1,...: Значения макросов в запросе.
string $message: Текст системного сообщения.
int $type: Тип сообщения (SB_MSG_INFORMATION, SB_MSG_WARNING и т.д.).
&$total

show (строка 382)

Возвращает HTML-код для номеров страниц

Для настройки данного вывода используйте соотв. переменные класса.

return: HTML-код для номеров страниц

strign show ()

Техническая поддержка:

Сайт: http://www.sbuilder.ru/tec_support.php
E-mail: support@sbuilder.ru