Class: Structures_DataGrid_Renderer_Pager

Source Location: /Structures_DataGrid_Renderer_Pager-0.1.3/DataGrid/Renderer/Pager.php

Class Overview

Structures_DataGrid_Renderer
   |
   --Structures_DataGrid_Renderer_Pager

Pager rendering driver

Author(s):

Olivier Guilyardi <olivier at samalyse.com>
Andrew S. Nagy <asnagy at webitecture.org>
Mark Wiesemann <wiesemann at php.net>
Sascha Grossenbacher <saschagros at bluewin.ch>

Version:

$Revision: 1.29 $

Variables

$_pager

Methods

Inherited Variables

Inherited Methods

Class Details

[line 96]
Pager rendering driver

This driver provides generic paging.

This driver has full container support. You can use the Structures_DataGrid::fill() method with it.

It buffers output, you can use Structures_DataGrid::getOutput()

SUPPORTED OPTIONS:

pagerOptions: (array) Options passed to Pager::factory(). Basic defaults are: mode: Sliding, delta: 5, separator: "|", prevImg: "<<" (<<), nextImg: ">>" (>>). The extraVars and excludeVars options are populated according to the Renderer common extraVars and excludeVars options. You may also specify some variables to be added or excluded here. The totalItems, perPage, urlVar, and currentPage options are set accordingly to the data statistics reported by the DataGrid and DataSource. You may overload these values here if you know what you are doing.
columnAttributes: (-) IGNORED

SUPPORTED OPERATION MODES:

Container Support: yes
Output Buffering: yes
Direct Rendering: no
Streaming: no
Object Preserving: no

Author: Olivier Guilyardi <olivier@samalyse.com>
Author: Andrew S. Nagy <asnagy@webitecture.org>
Author: Mark Wiesemann <wiesemann@php.net>
Author: Sascha Grossenbacher <saschagros@bluewin.ch>
Version: $Revision: 1.29 $
See: Pager::factory()
Access: public

[ Top ]

Class Variables

$_pager =

[line 103]

Rendering container

Var: object
Access: protected

Type:

object Pager

[ Top ]

Method Detail

Structures_DataGrid_Renderer_Pager (Constructor) [line 112]

Structures_DataGrid_Renderer_Pager Structures_DataGrid_Renderer_Pager(
)

Constructor

Set default options values

Access: public

[ Top ]

buildBody [line 334]

void buildBody(
)

Rebuild the pager links

This is useful because the pager options may change after it gets instantiated.

Access: protected

[ Top ]

flatten [line 248]

string flatten(
)

Retrieve links from the Pager object

Return: HTML links
Access: protected

[ Top ]

getContainer [line 159]

object Pager &getContainer(
)

Return the currently used Pager object

Return: (reference to) or PEAR_Error
Access: public

[ Top ]

init [line 170]

void init(
)

Instantiate the Pager container if needed, and set it up

Access: protected

[ Top ]

setContainer [line 147]

mixed setContainer(

&$pager)

Attach an already instantiated Pager object

Var: object
Return: True or PEAR_Error
Access: public

Parameters:

&$pager —

[ Top ]

setOption [line 313]

void setOption(
string
$name, mixed
$value)

Set a single option

Access: public

Parameters:

string	`$name`	—	Option name
mixed	`$value`	—	Option value

[ Top ]

setOptions [line 286]

void setOptions(
mixed
$options)

Set multiple options

Access: public

Parameters:

mixed $options — An associative array of the form: array("option_name" => "option_value",...)

[ Top ]

setupAs [line 263]

void setupAs(

&$renderer, array
$pagerOptions, object
$renderer)

Helper methods for drivers that automatically load this driver

This is (or has been...) used by the HTMLTable and Smarty driver

Access: public

Parameters:

object	`$renderer`	—	External driver
array	`$pagerOptions`	—	pager options
	`&$renderer`	—

[ Top ]