Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools

You are here: start » scriptlog » lib » core » paginator
Trace: • daoclassesexistencetest
scriptlog:lib:core:paginator

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
scriptlog:lib:core:paginator [2026/09/26 09:09] – admin adminscriptlog:lib:core:paginator [2026/09/26 09:34] (current) – admin admin
Line 10: Line 10:
 ======= Docblock Metadata ======= ======= Docblock Metadata =======
  
-  ^ Tag ^ Value ^ +^ Tag ^ Value ^ 
-  | ''@category'' | Core Class | +| ''@category'' | Core Class | 
-  | ''@author'' | David Carr - [email protected] - http://www.daveismyname.com | +| ''@author'' | David Carr - [email protected] - http://www.daveismyname.com | 
-  | ''@version'' | 1.0 | +| ''@version'' | 1.0 | 
-  | ''@since'' | October 20, 2012 |+| ''@since'' | October 20, 2012 |
  
 ======= Inheritance ======= ======= Inheritance =======
Line 24: Line 24:
 //None.// //None.//
  
-======= Properties (2) =======+======= Properties (6) =======
  
-  ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ +^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
-  | ''private'' | ''(untyped)'' | ''$_totalRows'' | ''10;'' | 47 | +| ''private'' | ''(untyped)'' | ''$_perPage'' |  | 24 | 
-  | ''private'' | ''(untyped)'' | ''$_paginationHtml'' | '''';'' | 58 |+| ''private'' | ''(untyped)'' | ''$_instance'' |  | 31 | 
 +| ''private'' | ''(untyped)'' | ''$_page'' |  | 38 | 
 +| ''private'' | ''(untyped)'' | ''$_totalRows'' | ''10'' | 47 | 
 +| ''private'' | ''(untyped)'' | ''$_sanitize'' |  | 53 | 
 +| ''private'' | ''(untyped)'' | ''$_paginationHtml'' | '''''' | 58 |
  
 ======= Methods (13) ======= ======= Methods (13) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''__construct()'' | __construct | 68 | +| public | ''__construct()'' | __construct | 68 | 
-  | private | ''get_start()'' | get_start | 84 | +| private | ''get_start()'' | get_start | 84 | 
-  | private | ''set_instance()'' | set_instance | 97 | +| private | ''set_instance()'' | set_instance | 97 | 
-  | public | ''set_total()'' | set_total | 111 | +| public | ''set_total()'' | set_total | 111 | 
-  | public | ''get_limit()'' | get_limit | 122 | +| public | ''get_limit()'' | get_limit | 122 | 
-  | public | ''get_limit_keys()'' | get_limit_keys | 137 | +| public | ''get_limit_keys()'' | get_limit_keys | 137 | 
-  | public | ''page_links()'' | page_links | 151 | +| public | ''page_links()'' | page_links | 151 | 
-  | private | ''buildPageNumbers()'' | (undocumented) | 189 | +| private | ''buildPageNumbers()'' | (undocumented) | 189 | 
-  | private | ''buildPageLink()'' | (undocumented) | 213 | +| private | ''buildPageLink()'' | (undocumented) | 213 | 
-  | private | ''buildAllPages()'' | (undocumented) | 223 | +| private | ''buildAllPages()'' | (undocumented) | 223 | 
-  | private | ''buildEarlyPages()'' | (undocumented) | 230 | +| private | ''buildEarlyPages()'' | (undocumented) | 230 | 
-  | private | ''buildMiddlePages()'' | (undocumented) | 240 | +| private | ''buildMiddlePages()'' | (undocumented) | 240 | 
-  | private | ''buildLatePages()'' | (undocumented) | 255 |+| private | ''buildLatePages()'' | (undocumented) | 255 |
  
  
Line 58: Line 62:
 pass values when class is istantiated pass values when class is istantiated
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$perPage'' | ''(untyped)'' | //required// | //none// | +|  ''$perPage'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$instance'' | ''(untyped)'' | //required// | //none// |+|  ''$instance'' |  ''(untyped)'' |  //required// |  //none// |
  
  
Line 103: Line 107:
 collect a numberic value and assigns it to the totalRows collect a numberic value and assigns it to the totalRows
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$_totalRows'' | ''(untyped)'' | //required// | //none// |+|  ''$_totalRows'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 119: Line 123:
 returns the limit for the data source, calling the get_start method and passing in the number of items perp page returns the limit for the data source, calling the get_start method and passing in the number of items perp page
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// |+|  ''$sanitize'' |  [[scriptlog:lib:core:sanitize|''Sanitize'']] |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 150: Line 154:
 create the html links for navigating through the dataset create the html links for navigating through the dataset
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// | +|  ''$sanitize'' |  [[scriptlog:lib:core:sanitize|''Sanitize'']] |  //required// |  //none// | 
-  | ''$path'' | ''(untyped)'' | '''?''' | //none// | +|  ''$path'' |  ''(untyped)'' |  '''?''' |  //none// | 
-  | ''$ext'' | ''(untyped)'' | ''null'' | //none// |+|  ''$ext'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — string returns the html menu **Returns:** ''(none declared)'' — string returns the html menu
Line 166: Line 170:
 //lines 189–211 (23)// //lines 189–211 (23)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$path'' | ''(untyped)'' | //required// | //none// | +|  ''$path'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$ext'' | ''(untyped)'' | //required// | //none// | +|  ''$ext'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$adjacents'' | ''(untyped)'' | //required// | //none// | +|  ''$adjacents'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lastpage'' | ''(untyped)'' | //required// | //none// | +|  ''$lastpage'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lpm1'' | ''(untyped)'' | //required// | //none// |+|  ''$lpm1'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 184: Line 188:
 //lines 213–221 (9)// //lines 213–221 (9)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$counter'' | ''(untyped)'' | //required// | //none// | +|  ''$counter'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$path'' | ''(untyped)'' | //required// | //none// | +|  ''$path'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$ext'' | ''(untyped)'' | //required// | //none// |+|  ''$ext'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 200: Line 204:
 //lines 223–228 (6)// //lines 223–228 (6)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$path'' | ''(untyped)'' | //required// | //none// | +|  ''$path'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$ext'' | ''(untyped)'' | //required// | //none// | +|  ''$ext'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lastpage'' | ''(untyped)'' | //required// | //none// |+|  ''$lastpage'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 216: Line 220:
 //lines 230–238 (9)// //lines 230–238 (9)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$path'' | ''(untyped)'' | //required// | //none// | +|  ''$path'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$ext'' | ''(untyped)'' | //required// | //none// | +|  ''$ext'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$adjacents'' | ''(untyped)'' | //required// | //none// | +|  ''$adjacents'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lastpage'' | ''(untyped)'' | //required// | //none// | +|  ''$lastpage'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lpm1'' | ''(untyped)'' | //required// | //none// |+|  ''$lpm1'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 234: Line 238:
 //lines 240–253 (14)// //lines 240–253 (14)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$path'' | ''(untyped)'' | //required// | //none// | +|  ''$path'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$ext'' | ''(untyped)'' | //required// | //none// | +|  ''$ext'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$adjacents'' | ''(untyped)'' | //required// | //none// | +|  ''$adjacents'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lastpage'' | ''(untyped)'' | //required// | //none// | +|  ''$lastpage'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lpm1'' | ''(untyped)'' | //required// | //none// |+|  ''$lpm1'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 252: Line 256:
 //lines 255–264 (10)// //lines 255–264 (10)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$path'' | ''(untyped)'' | //required// | //none// | +|  ''$path'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$ext'' | ''(untyped)'' | //required// | //none// | +|  ''$ext'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$adjacents'' | ''(untyped)'' | //required// | //none// | +|  ''$adjacents'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lastpage'' | ''(untyped)'' | //required// | //none// | +|  ''$lastpage'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$lpm1'' | ''(untyped)'' | //required// | //none// |+|  ''$lpm1'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
scriptlog/lib/core/paginator.1790413762.txt.gz · Last modified: by admin