Class flWidgetPagination

flWidgetPagination Class

Class to generate a page selection widget.

Package: fusionLib
Copyright: Copyright (c) 2008 - 2013 fusionLib. All rights reserved.
Located at system/libs/Widget/flWidgetPagination.php

Methods summary

`public`	# `__construct( integer $page, integer $totalRows, integer $rowsPerPage = 20, integer $range = 5 )` Construct a new object. Construct a new object. Parameters `$page` The current page number. `$totalRows` The total number of rows. `$rowsPerPage` The number of rows to show per page. `$range` The number of pages to show either side of the active page.
`public flWidgetPagination`	# `setRoute( flRouterRoute $route, array $baseParams, string $pageParamName = '*', array $parameters = array(), string $marker = null )` Set the route object used for building the URIs. Set the route object used for building the URIs. Parameters `$route` The route object. `$baseParams` Array of parameters to use when construction URLs `$pageParamName` The name of the page parameter in the URI. `$parameters` Key name pairs for parameters to append to URI. `$marker` Name of optional marker for the page number, replaces :marker for pages > 0. Returns `flWidgetPagination` This object
`public flWidgetPagination`	# `setURI( string $uri, array $baseParams, string $pageParamName = 'page' )` Set the URI and parameters to use for building the URIs. Set the URI and parameters to use for building the URIs. Parameters `$uri` The page URI. `$baseParams` Parameters to include in every URI. `$pageParamName` The name of the page parameter in the URI Returns `flWidgetPagination` This object
`public flWidgetPagination`	# `setClass( string $css )` Set the CSS class to use. Set the CSS class to use. Parameters `$css` The CSS class, default is 'paginationwidget'. Returns `flWidgetPagination` This object.
`public string`	# `render( )` Draw the page selection as an unordered list. Draw the page selection as an unordered list. Returns string The string holding the html.
`protected string`	# `assemble( integer $page )` Make the URI for the given page. Make the URI for the given page. Parameters `$page` The page number to make the URI for. Returns string The URI.
`public integer`	# `getStart( )` Get the start value for use in SQL LIMIT. Get the start value for use in SQL LIMIT. Returns integer The start value.
`public integer`	# `getRows( )` Get the rows for use in SQL LIMIT. Get the rows for use in SQL LIMIT. Returns integer The rows value.
`public integer`	# `getNumPages( )` Get the total number of pages required to show the rows. Get the total number of pages required to show the rows. Returns integer The number of pages.
`public integer`	# `getPage( )` Get the current page. Get the current page. Returns integer The current page number.
`public flWidgetPagination`	# `withPage0ID( boolean $include = true )` Force page 0 ID to be included within the generated URL. Force page 0 ID to be included within the generated URL. Parameters `$include` true to include the page 0 ID; else false. Returns `flWidgetPagination` This object.

Properties summary

`protected boolean`	`$withPage0ID` Flags if the page ID should be included for page 0 Flags if the page ID should be included for page 0	# `false`
`protected flRouterRoute`	`$route` The route to use. The route to use.	# `null`
`protected string`	`$uri` The URI of the page if not using a flRouterRoute object. The URI of the page if not using a flRouterRoute object.	# `null`
`protected array`	`$baseParams` Array of base parameters. Array of base parameters.	# `array()`
`protected string`	`$pageParamName` The name of the parameter holding the page number. The name of the parameter holding the page number.	# `'page'`
`protected null`	`$marker` The page number marker. The page number marker.	# `null`
`protected string`	`$css` The CSS class to apply to the table. The CSS class to apply to the table.	# `'paginationwidget'`
`protected array`	`$parameters` Paramters to append to uri when using routes Paramters to append to uri when using routes	# `''`