Dotclear 2.25
Loading...
Searching...
No Matches
pager Class Reference

(x)HTML Pager More...

Inheritance diagram for pager:
dcPager

Public Member Functions

 __construct (int $env, int $nb_elements, int $nb_per_page=10, int $nb_pages_per_group=10)
 
 getLinks ()
 
 debug ()
 

Data Fields

 $index_start
 
 $index_end
 
 $base_url = null
 
 $var_page = 'page'
 
 $html_cur_page = '<strong>%s</strong>'
 
 $html_link_sep = '-'
 
 $html_prev = '&#171;prev.'
 
 $html_next = 'next&#187;'
 
 $html_prev_grp = '...'
 
 $html_next_grp = '...'
 

Protected Member Functions

 setURL ()
 

Protected Attributes

 $env
 
 $nb_elements
 
 $nb_per_page
 
 $nb_pages_per_group
 
 $nb_pages
 
 $nb_groups
 
 $env_group
 
 $index_group_start
 
 $index_group_end
 
 $page_url = null
 

Detailed Description

(x)HTML Pager

This class implements a pager helper to browse any type of results.

Constructor & Destructor Documentation

◆ __construct()

__construct ( int  $env,
int  $nb_elements,
int  $nb_per_page = 10,
int  $nb_pages_per_group = 10 
)

Constructor

Parameters
int$envCurrent page index
int$nb_elementsTotal number of elements
int$nb_per_pageNumber of items per page
int$nb_pages_per_groupNumber of pages per group

References $env, $nb_elements, $nb_pages, $nb_pages_per_group, and $nb_per_page.

Member Function Documentation

◆ getLinks()

getLinks ( )

Pager Links

Returns pager links

Returns
string

Reimplemented in dcPager.

References $html_link_sep, $index_group_end, and setURL().

◆ setURL()

setURL ( )
protected

Sets the page URI

Reimplemented in dcPager.

References $base_url, and html\escapeHTML().

Referenced by getLinks().

◆ debug()

debug ( )

References $index_group_end.

Field Documentation

◆ $env

$env
protected

Referenced by __construct().

◆ $nb_elements

$nb_elements
protected

Referenced by __construct().

◆ $nb_per_page

$nb_per_page
protected

Referenced by __construct().

◆ $nb_pages_per_group

$nb_pages_per_group
protected

Referenced by __construct().

◆ $nb_pages

$nb_pages
protected

Referenced by __construct().

◆ $nb_groups

$nb_groups
protected

◆ $env_group

$env_group
protected

◆ $index_group_start

$index_group_start
protected

◆ $index_group_end

$index_group_end
protected

Referenced by debug(), and getLinks().

◆ $page_url

$page_url = null
protected

◆ $index_start

$index_start

◆ $index_end

$index_end

◆ $base_url

$base_url = null

Referenced by setURL().

◆ $var_page

$var_page = 'page'

◆ $html_cur_page

$html_cur_page = '<strong>%s</strong>'

◆ $html_link_sep

$html_link_sep = '-'

Referenced by getLinks().

◆ $html_prev

$html_prev = '&#171;prev.'

◆ $html_next

$html_next = 'next&#187;'

◆ $html_prev_grp

$html_prev_grp = '...'

◆ $html_next_grp

$html_next_grp = '...'

The documentation for this class was generated from the following file: