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

Class: A_Pager

Source Location: /Pager.php

Class Overview


A_Pager


Author(s):

Variables

Methods



Class Details

[line 16]
A_Pager



Tags:

see:  A_Pagination
deprecated:  replaced by A_Pagination package


[ Top ]


Class Variables

$current_page =  0

[line 32]



Tags:

var:  Number of current page
access:  public

Type:   integer


[ Top ]

$datasource =  null

[line 20]



Tags:

var:  Pageable datasource object
access:  public

Type:   mixed


[ Top ]

$end_row =  0

[line 56]



Tags:

var:  ???
access:  public

Type:   integer


[ Top ]

$first_page =  1

[line 36]



Tags:

var:  ???
access:  public

Type:   integer


[ Top ]

$first_row =  1

[line 44]



Tags:

var:  ???
access:  public

Type:   integer


[ Top ]

$last_page =  -1

[line 40]



Tags:

var:  ???
access:  public

Type:   integer


[ Top ]

$last_row =  0

[line 48]



Tags:

var:  ???
access:  public

Type:   integer


[ Top ]

$last_row_param =  'last_row'

[line 64]



Tags:

var:  ???
access:  public

Type:   string


[ Top ]

$order_by_current_desc =  0

[line 88]



Tags:

var:  0=ascending or 1=descending for current field
access:  public

Type:   integer


[ Top ]

$order_by_current_field =  ''

[line 84]



Tags:

var:  Currently sorting on this field
access:  public

Type:   string


[ Top ]

$order_by_default_field =  ''

[line 80]



Tags:

var:  Initial sort order
access:  public

Type:   string


[ Top ]

$order_by_fields = array()

[line 76]



Tags:

var:  field names in database e.g. myfield or mytable.myfield
access:  public

Type:   array


[ Top ]

$order_by_param =  'order_by'

[line 72]



Tags:

var:  ???
access:  public

Type:   string


[ Top ]

$page_param =  'page'

[line 60]



Tags:

var:  Parameter names for URLs
access:  public

Type:   string


[ Top ]

$page_size =  10

[line 24]



Tags:

var:  Number of rows of data per page
access:  public

Type:   integer


[ Top ]

$page_size_param =  'page_size'

[line 68]



Tags:

var:  ???
access:  public

Type:   string


[ Top ]

$range_size =  10

[line 28]



Tags:

var:  Number of links in pager
access:  public

Type:   integer


[ Top ]

$start_row =  0

[line 52]



Tags:

var:  ???
access:  public

Type:   integer


[ Top ]



Class Methods


constructor __construct [line 95]

A_Pager __construct( mixed $datasource)

__construct



Tags:

access:  public


Parameters:

mixed   $datasource   ???

[ Top ]

method getCurrentPage [line 283]

mixed getCurrentPage( )

getCurrentPage



Tags:

return:  The current page
access:  public


[ Top ]

method getEndRow [line 373]

mixed getEndRow( )

getEndRow



Tags:

return:  ???
access:  public


[ Top ]

method getFirstPage [line 337]

mixed getFirstPage( )

getFirstPage



Tags:

return:  The index of the first page
access:  public


[ Top ]

method getFirstRow [line 346]

mixed getFirstRow( )

getFirstRow



Tags:

return:  ???
access:  public


[ Top ]

method getLastPage [line 328]

mixed getLastPage( )

getLastPage



Tags:

return:  The index of the last page
access:  public


[ Top ]

method getLastRow [line 355]

mixed getLastRow( )

getLastRow



Tags:

return:  ???
access:  public


[ Top ]

method getNextPage [line 311]

mixed getNextPage( [integer $length = 1])

getNextPage



Tags:

return:  The index of the next page
access:  public


Parameters:

integer   $length   ??? (optional)

[ Top ]

method getOrderByParameter [line 226]

array getOrderByParameter( mixed $field)

getOrderByParameter



Tags:

return:  ???
access:  public


Parameters:

mixed   $field   ???

[ Top ]

method getPageSize [line 274]

mixed getPageSize( )

getPageSize



Tags:

return:  The current page size
access:  public


[ Top ]

method getPrevPage [line 293]

mixed getPrevPage( [integer $length = 1])

getPrevPage



Tags:

return:  The index of the previous page
access:  public


Parameters:

integer   $length   ??? (optional)

[ Top ]

method getRange [line 400]

array getRange( [integer $range_start = 0], [integer $range_end = 0])

getRange



Tags:

return:  Range of results from $range_start to $range_end
access:  public


Parameters:

integer   $range_start   Beginning of range to get (optional)
integer   $range_end   End of range to get (optional)

[ Top ]

method getRows [line 429]

mixed getRows( [integer $start_row = 0], [integer $end_row = 0])

getRows



Tags:

return:  ???
access:  public


Parameters:

integer   $start_row   ??? (optional)
integer   $end_row   ??? (optional)

[ Top ]

method getStartRow [line 364]

mixed getStartRow( )

getStartRow



Tags:

return:  ???
access:  public


[ Top ]

method getValues [line 382]

mixed getValues( )

getValues



Tags:

return:  ???
access:  public


[ Top ]

method hasPages [line 442]

boolean hasPages( )

hasPages



Tags:

return:  True if there are more than one pages
access:  public


[ Top ]

method setCurrentPage [line 242]

A_Pager setCurrentPage( mixed $n)

setCurrentPage



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $n   Page to show

[ Top ]

method setLastRowParameter [line 153]

A_Pager setLastRowParameter( mixed $name)

setLastRowParameter



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $name   ???

[ Top ]

method setOrderByCurrent [line 165]

A_Pager setOrderByCurrent( mixed $field, mixed $direction)

setOrderByCurrent



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $field   ???
mixed   $direction   ???

[ Top ]

method setOrderByFields [line 198]

A_Pager setOrderByFields( mixed $fields, [mixed $default_field = false])

setOrderByFields



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $fields   ???
mixed   $default_field   ??? (optional)

[ Top ]

method setOrderByParameter [line 215]

A_Pager setOrderByParameter( mixed $name)

setOrderByParameter



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $name   ???

[ Top ]

method setPageParameter [line 131]

A_Pager setPageParameter( mixed $name)

setPageParameter



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $name   ???

[ Top ]

method setPageSize [line 105]

A_Pager setPageSize( integer $n)

setPageSize



Tags:

return:  This object instance
access:  public


Parameters:

integer   $n   Number of results to show on each page

[ Top ]

method setPageSizeParameter [line 142]

A_Pager setPageSizeParameter( mixed $name)

setPageSizeParameter



Tags:

return:  This object instance
access:  public


Parameters:

mixed   $name   ???

[ Top ]

method setRangeSize [line 118]

A_Pager setRangeSize( integer $n)

setRangeSize



Tags:

return:  This object instance
access:  public


Parameters:

integer   $n   ???

[ Top ]


Documentation generated on Sun, 24 Jul 2011 00:03:33 +0000 by phpDocumentor 1.4.3