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

Class: PEAR_Size_Output_Driver

Source Location: /PEAR_Size-1.0.0RC1/PEAR/Size/Factory.php

Class Overview


An Output Driver is used to display information/text in a manner specific to that driver.


Author(s):

Version:

  • Release: @PACKAGE_VERSION@

Copyright:

  • 2008 Ken Guest

Methods


Child classes:

PEAR_Size_Output_XML
Output info in XML format
PEAR_Size_Output_Html
PEAR_Size_Output_html
PEAR_Size_Output_CSV
Output info in Comma Seperated Value style.
PEAR_Size_Output_Text
Output info as pure text.

Inherited Variables

Inherited Methods


Class Details

[line 49]
An Output Driver is used to display information/text in a manner specific to that driver.


[ Top ]


Method Detail

channelReport   [line 204]

void channelReport( array $stats, mixed $details)

Display report of packages in a channel
  • Access: protected

Parameters:

array   $stats   —  array of statistics
mixed   $details   —  additional details

[ Top ]

display   [line 131]

void display( string $text)

Display given text.
  • Access: public

Overridden in child classes as:

PEAR_Size_Output_Html::display()
display given text.
PEAR_Size_Output_Text::display()
Display given text.

Parameters:

string   $text   —  text to be displayed

[ Top ]

generateReport   [line 146]

void generateReport( array $channel_stats, array $search_roles, array $grand_total, array $display_params)

Generate the report
  • Access: public

Overridden in child classes as:

PEAR_Size_Output_XML::generateReport()
Generate the report
PEAR_Size_Output_Html::generateReport()
generate the report
PEAR_Size_Output_CSV::generateReport()
Generate the report
PEAR_Size_Output_Text::generateReport()
Generate the report

Parameters:

array   $channel_stats   —  contains statistics for each channel
array   $search_roles   —  roles searched for
array   $grand_total   —  entire total of disk space consumed by channel
array   $display_params   —  parameters relevant to display of report.

[ Top ]

readableLine   [line 115]

string readableLine( integer $value, boolean $readable, boolean $round)

Return either given value, or it in readable form depending on criteria.
  • Access: protected

Parameters:

integer   $value   —  value
boolean   $readable   —  human readable form?
boolean   $round   —  round to values of 1000 rather than 1024?

[ Top ]


Documentation generated on Sat, 01 Aug 2015 01:30:09 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.