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

Class: Structures_DataGrid_Renderer_Console

Source Location: /Structures_DataGrid_Renderer_Console-0.1.1/DataGrid/Renderer/Console.php

Class Overview

Structures_DataGrid_Renderer
   |
   --Structures_DataGrid_Renderer_Console

Console Table Rendering Driver


Author(s):

Version:

  • $Revision: 1.19 $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 73]
Console Table Rendering Driver

This renderer generates nicely formatted and padded ASCII tables.

SUPPORTED OPTIONS:

  • columnAttributes: (-) IGNORED
SUPPORTED OPERATION MODES:

  • Container Support: yes
  • Output Buffering: yes
  • Direct Rendering: no
  • Streaming: no



[ Top ]


Class Variables

$_table =

[line 80]

Console_Table container
  • Access: protected

Type:   object


[ Top ]



Method Detail

Structures_DataGrid_Renderer_Console (Constructor)   [line 89]

Structures_DataGrid_Renderer_Console Structures_DataGrid_Renderer_Console( )

Constructor

Build default values

  • Access: public

[ Top ]

buildHeader   [line 181]

void buildHeader( )

Handles building the header of the table
  • Access: protected

[ Top ]

buildRow   [line 201]

void buildRow( int $index, array $data)

Build a body row
  • Abstract:
  • Access: protected

Parameters:

int   $index     Row index (zero-based)
array   $data     Record data. Structure: array(0 => <value0>, 1 => <value1>, ...)

[ Top ]

flatten   [line 212]

string flatten( )

Retrieve output from the container object
  • Return: Output
  • Access: protected

[ Top ]

getContainer   [line 119]

object Console_Table &getContainer( &$consoleTable)

Return the internal Console_Table container
  • Return: or PEAR_Error
  • Access: public

Parameters:

   &$consoleTable     

[ Top ]

getTable   [line 170]

object Console_Table &getTable( )

Gets the Console_Table object for the DataGrid

OBSOLETE

  • Return: The Console_Table object for the DataGrid
  • Access: public

[ Top ]

init   [line 133]

void init( )

Instantiate the Console_Table container if it hasn't been provided
  • Access: protected

[ Top ]

setContainer   [line 107]

mixed setContainer( &$consoleTable, object $consoleTable)

Attach an already instantiated Console_Table object
  • Return: True or a PEAR_Error
  • Access: public

Parameters:

object   $consoleTable     
   &$consoleTable     

[ Top ]

toAscii   [line 157]

string toAscii( )

Returns the output of the table
  • Return: The output of the table
  • Access: public

[ Top ]

useHeader   [line 146]

void useHeader( bool $bool)

Determines whether or not to use the Header
  • Access: public

Parameters:

bool   $bool     value to determine to use the header or not.

[ Top ]


Documentation generated on Sat, 16 Dec 2006 11:30:18 -0500 by phpDocumentor 1.3.0. PEAR Logo Copyright © PHP Group 2004.