[ Index ]

PHP Cross Reference of Akelos Framework

title

Body

[close]

/AkActionController/ -> AkPaginator.php (summary)

(no description)

Author: Bermi Ferrer
Copyright: Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
License: GNU Lesser General Public License
File Size: 476 lines (19 kb)
Included or required: 3 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

AkPager:: (6 methods):
  init()
  getPageIdByOffset()
  getPageRangeByPageId()
  getLinks()
  _getPageLinks()
  _renderLink()

AkPaginator:: (14 methods):
  AkPaginator()
  getController()
  getItemCount()
  getItemsPerPage()
  getOffset()
  getCurrent()
  getCurrentPage()
  getFirstPage()
  getFirst()
  getLast()
  pageCount()
  lenght()
  hasPageNumber()
  links()


Class: AkPager  - X-Ref

AkPager and AkPaginator are a fork of Pear::Pager
coded by  Lorenzo Alberton <at quipo.it> and
Richard Heyes <mailto:richard at phpguru.org>,

init($options = array()   X-Ref
Constructor

param: mixed $options    An associative array of option names

getPageIdByOffset($index=null)   X-Ref
"Overload" PEAR::Pager method. VOID. Not needed here...

param: integer $index Offset to get pageID for

getPageRangeByPageId($pageid = null)   X-Ref
Given a PageId, it returns the limits of the range of pages displayed.
While getOffsetByPageId() returns the offset of the data within the
current page, this method returns the offsets of the page numbers interval.
E.g., if you have pageId=5 and delta=2, it will return (3, 7).
PageID of 9 would give you (4, 8).
If the method is called without parameter, pageID is set to currentPage#.

param: integer PageID to get offsets for
return: array  First and last offsets

getLinks($pageID = null)   X-Ref
Returns back/next/first/last and page links,
both as ordered and associative array.

param: integer $pageID Optional pageID. If specified, links
return: array back/pages/next/first/last/all links

_getPageLinks($url = '')   X-Ref
Returns pages link

return: string Links

_renderLink($altText, $linkText)   X-Ref
Renders a link using the appropriate method

param: altText Alternative text for this link (title property)
param: linkText Text contained by this link
return: string The link in string form

Class: AkPaginator  - X-Ref

A class representing a paginator for an Active Record collection.

AkPaginator(&$controller, $item_count, $items_per_page, $current_page=1)   X-Ref
Creates a new AkPaginator on the given +controller+ for a set of items
of size +item_count+ and having +items_per_page+ items per page.
Raises an error if items_per_page is out of bounds (i.e., less
than or equal to zero). The page GET parameter for links defaults to
"page" and can be overridden with +page_parameter+.


getController()   X-Ref
No description

getItemCount()   X-Ref
No description

getItemsPerPage()   X-Ref
No description

getOffset()   X-Ref
No description

getCurrent()   X-Ref
No description

getCurrentPage()   X-Ref
No description

getFirstPage()   X-Ref
No description

getFirst()   X-Ref
No description

getLast()   X-Ref
No description

pageCount()   X-Ref
No description

lenght()   X-Ref
No description

hasPageNumber($number)   X-Ref
Returns true if this paginator contains the page of index +number+.


links()   X-Ref
No description



Generated: Mon Oct 27 12:43:49 2008 Cross-referenced by PHPXref 0.6