Docs For Class Gadget

Description

Gadget_Pager

Provides paging routines.

Template Example:

 <p class="center">
     {if: $hasPrev}
         <a href="{$widget->href($prev)}">&laquo; forward</a>
     {else}
         &laquo; forward
     {end}
     <span>|</span>
     {foreach: $moveLinks as $l}
         {if: $l->active}
             {$l->num}
         {else}
             <a href="{$widget->href($l->offset)}">{$l->num}</a>
         {end}
     <span>|</span>
     {end}
     {if: $hasNext}
         <a href="{$widget->href($next)}">back &raquo;</a>
     {else}
         back &raquo;
     {end}
 </p>

since: 1.0

Located in /Gadget/Pager.php (line 58)

Gadget_Object
   |
   --Gadget_Widget
      |
      --Gadget_Pager

Variable Summary

bool $aggregateFormatter

bool $hasNext

bool $hasPrev

int $limit

array $moveLinks

int $next

int $offset

bool $page

int $prev

Method Summary

int getLimit ()

string href (int $offset, [bool $amp = true])

void makeMetaLinks (int $total)

void makeMoveLinks (int $total)

void makePrevNext (int $total)

void onAfterConstruct ()

void onBeforeConstruct ()

void page (int $total)

Variables

bool $aggregateFormatter = true (line 121)

Load Gadget_Formatter by default

Redefinition of:

Gadget_Widget::$aggregateFormatter: Whether to call aggregateFormatter() at construction time

bool $hasNext = false (line 86)

Has next page

bool $hasPrev = false (line 79)

Has previous page

int $limit = 10 (line 100)

Limit

array $moveLinks = array() (line 107)

Move Links

int $next = 0 (line 72)

Offset of next page

int $offset = 0 (line 93)

Current Offset

bool $page = true (line 114)

Whether to do anything if page() is called

int $prev = 0 (line 65)

Offset of previous page

Inherited Variables

Inherited from Gadget_Widget

Gadget_Widget::$auth
Gadget_Widget::$elements
Gadget_Widget::$form
Gadget_Widget::$ID
Gadget_Widget::$location
Gadget_Widget::$main
Gadget_Widget::$qform
Gadget_Widget::$queryString
Gadget_Widget::$render
Gadget_Widget::$rights
Gadget_Widget::$show
Gadget_Widget::$template

Methods

getLimit (line 164)

Get Limit

Override this in your Widget to return a custom limit.

access: public

int getLimit ()

href (line 195)

Href

access: public

string href (int $offset, [bool $amp = true])

int $offset
bool $amp

makeMetaLinks (line 224)

Make Meta Links

access: protected

void makeMetaLinks (int $total)

int $total

makeMoveLinks (line 256)

Make Move Links

access: protected

void makeMoveLinks (int $total)

int $total

makePrevNext (line 208)

Make Prev and Next Calculations

access: protected

void makePrevNext (int $total)

int $total

onAfterConstruct (line 147)

On After Construct

access: protected

void onAfterConstruct ()

Redefinition of:

Gadget_Widget::onAfterConstruct(): On After Construct

onBeforeConstruct (line 129)

On Before Construct

access: protected

void onBeforeConstruct ()

Redefinition of:

Gadget_Widget::onBeforeConstruct(): On Before Construct

page (line 178)

Page

This method must be called with the total count of items.

access: public

void page (int $total)

int $total

Inherited Methods

Inherited From Gadget_Widget

Gadget_Widget::aggregateFormatter()
Gadget_Widget::create()
Gadget_Widget::form()
Gadget_Widget::load()
Gadget_Widget::main()
Gadget_Widget::oddEven()
Gadget_Widget::onAfterConstruct()
Gadget_Widget::onBeforeConstruct()
Gadget_Widget::queue()
Gadget_Widget::queueAfter()
Gadget_Widget::render()
Gadget_Widget::requeue()
Gadget_Widget::unqueue()
Gadget_Widget::unsufficientRights()

Inherited From Gadget_Object

Gadget_Object::Gadget_Object()
Gadget_Object::onAfterConstruct()
Gadget_Object::onBeforeConstruct()
Gadget_Object::setOptions()

Class Gadget_Pager

Inherited Variables

Inherited Methods