XOOPS  2.6.0
XoopsPageNav Class Reference

Public Member Functions

 __construct ($total_items, $items_perpage, $current_start, $start_name="start", $extra_arg="")
 
 renderImageNav ($offset=4)
 
 renderNav ($offset=4, $size="", $align="right", $prev_text="«", $next_text="»")
 
 renderSelect ($align="right", $showbutton=false)
 

Private Attributes

 $current
 
 $extra
 
 $perpage
 
 $total
 
 $url
 

Detailed Description

Definition at line 23 of file pagenav.php.

Constructor & Destructor Documentation

XoopsPageNav::__construct (   $total_items,
  $items_perpage,
  $current_start,
  $start_name = "start",
  $extra_arg = "" 
)

Constructor

Parameters
int$total_itemsTotal number of items
int$items_perpageNumber of items per page
int$current_startFirst item on the current page
string$start_nameName for "start" or "offset"
string$extra_argAdditional arguments to pass in the URL

Definition at line 64 of file pagenav.php.

References $_SERVER.

Member Function Documentation

XoopsPageNav::renderImageNav (   $offset = 4)

Create navigation with images

Parameters
integer$offset
Returns
string

Definition at line 214 of file pagenav.php.

References $xoops, Xoops\getInstance(), and renderNav().

Here is the call graph for this function:

XoopsPageNav::renderNav (   $offset = 4,
  $size = "",
  $align = "right",
  $prev_text = "«",
  $next_text = "»" 
)

Create text navigation

Parameters
integer$offsetoffset
string$sizeof pagination (Value: 'large', '', 'small', 'mini')
string$alignof pagination (Value: 'right', 'centered')
string$prev_texttext for previous
string$next_texttext for next
Returns
string

Definition at line 87 of file pagenav.php.

References $extra, $perpage, $xoops, and Xoops\getInstance().

Referenced by renderImageNav().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsPageNav::renderSelect (   $align = "right",
  $showbutton = false 
)

Create a navigational dropdown list

Parameters
boolean$showbuttonShow the "Go" button?
Returns
string|false

Definition at line 174 of file pagenav.php.

References $extra, $xoops, and Xoops\getInstance().

Here is the call graph for this function:

Member Data Documentation

XoopsPageNav::$current
private

Definition at line 43 of file pagenav.php.

XoopsPageNav::$extra
private

Definition at line 48 of file pagenav.php.

Referenced by renderNav(), and renderSelect().

XoopsPageNav::$perpage
private

Definition at line 38 of file pagenav.php.

Referenced by renderNav().

XoopsPageNav::$total
private

Definition at line 33 of file pagenav.php.

XoopsPageNav::$url
private

Definition at line 53 of file pagenav.php.


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