energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: Pager

Source Location: /framework/Pager.class.php

Class Overview

Object
   |
   --Pager

Список страниц для навигации при постраничном выводе.


Author(s):

  • 1m.dm

Variables

Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 24]
Список страниц для навигации при постраничном выводе.



Tags:

author:   1m.dm
final:  


[ Top ]


Class Variables

$currentPage =

[line 56]



Tags:

var:   номер текущей страницы
access:   private

Type:   int


[ Top ]

$numPages =  0

[line 44]



Tags:

var:   количество страниц
access:   private

Type:   int


[ Top ]

$properties = array()

[line 62]



Tags:

var:   дополнительные свойства списка страниц
access:   private

Type:   array


[ Top ]

$recordsCount =

[line 50]



Tags:

var:   общее количество записей
access:   private

Type:   int


[ Top ]

$recordsPerPage =

[line 38]



Tags:

var:   количество записей на странице
access:   private

Type:   int


[ Top ]



Class Methods


constructor __construct [line 72]

void __construct( [int $recordsPerPage = 0], [int $currentPage = 1])

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



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

Parameters:

int   $recordsPerPage  
int   $currentPage  

[ Top ]

method build [line 194]

DOMNode build( )

Строит документ списка страниц и возвращает ссылку на корневой узел документа.



Tags:

access:   public


[ Top ]

method getCurrentPage [line 161]

int getCurrentPage( )

Возвращает номер текущей страницы.



Tags:

access:   public


[ Top ]

method getLimit [line 184]

array getLimit( )

Возвращает лимит выборки для SELECT-запроса.



Tags:

see:   QAL::select()
access:   public


[ Top ]

method getNumPages [line 110]

int getNumPages( )

Возвращает количество страниц.



Tags:

access:   public


[ Top ]

method getRecordsCount [line 151]

int getRecordsCount( )

Возвращает общее количество записей.



Tags:

access:   public


[ Top ]

method getRecordsPerPage [line 100]

int getRecordsPerPage( )

Возвращает количество записей на странице.



Tags:

access:   public


[ Top ]

method setCurrentPage [line 120]

void setCurrentPage( int $currentPage)

Устанавливает номер текущей страницы.



Tags:

access:   public


Parameters:

int   $currentPage  

[ Top ]

method setProperty [line 173]

void setProperty( string $name, mixed $value)

Устанавливает свойство списка страниц.



Tags:

access:   public


Parameters:

string   $name  
mixed   $value  

[ Top ]

method setRecordsCount [line 135]

void setRecordsCount( int $count)

Устанавливает общее количество записей.



Tags:

access:   public


Parameters:

int   $count  

[ Top ]

method setRecordsPerPage [line 86]

void setRecordsPerPage( int $recordsPerPage)

Устанавливает количество записей на странице.



Tags:

access:   public


Parameters:

int   $recordsPerPage  

[ Top ]


Class Constants

VISIBLE_PAGES_COUNT =  2

[line 32]

Количество отображаемых номеров страниц с каждой стороны от текущей

Пример для VISIBLE_PAGES_COUNT = 3

  1. 2 ... 5 6 7 _8_ 9 10 11 ... 455 456



[ Top ]


В создании документации нам помог: phpDocumentor