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

Class: PEAR_Size

Source Location: /PEAR_Size-0.2.0/Size/Size.php

Class Overview


PEAR_Size: a class for determining the whole size that a package consumes on disk.


Author(s):

Version:

  • Release: 0.2.0

Copyright:

  • 2008 Ken Guest

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 50]
PEAR_Size: a class for determining the whole size that a package consumes on disk.


[ Top ]


Class Variables

$errors = array()

[line 126]

array or PEAR_Error of error messages
  • Access: public

Type:   array


[ Top ]

$reg =  null

[line 186]

Registry object
  • Access: protected

Type:   Registry


[ Top ]

$reg_channels = array()

[line 179]

list of channels returned by getChannels method.
  • Access: protected

Type:   array


[ Top ]

$search_roles =  ''

[line 202]

List of all valid roles to search for.

May be extended by child class for cases where pear installer is embedded and custom roles are in use.

  • Access: protected

Type:   string


[ Top ]

$warnings = array()

[line 134]

array of warning messages.
  • Access: public

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 314]

void __construct( )

class constructor
  • Access: public

[ Top ]

analyse   [line 594]

void analyse( )

main analysis method
  • Access: public

[ Top ]

generateReport   [line 681]

void generateReport( )

generate the report
  • Access: public

[ Top ]

parseCLIOptions   [line 522]

mixed parseCLIOptions( array $options)

parse options determined by Console_Getopt
  • Return: returns a PEAR_Error on failure
  • Access: public

Parameters:

array   $options     options specified (filled by Console_Getopt::getopt)

[ Top ]

setAll   [line 428]

void setAll( [bool $value = true])

Indicate whether all packages in a channel should be analysed.
  • Access: public

Parameters:

bool   $value     defaults to true.

[ Top ]

setAllChannels   [line 440]

void setAllChannels( [bool $mode = true])

set variables for analysing all channels.
  • Access: public

Parameters:

bool   $mode     defaults to true.

[ Top ]

setChannel   [line 484]

void setChannel( string $channel_name)

set which channel is to be used
  • Access: public

Parameters:

string   $channel_name     Either full or alias name of a channel

[ Top ]

setDontDisplayZeroValues   [line 404]

void setDontDisplayZeroValues( [bool $value = false])

Should the driver display/include zero values.
  • Access: public

Parameters:

bool   $value     defaults to false.

[ Top ]

setHumanReadable   [line 392]

void setHumanReadable( [bool $value = true])

human readable...

Should values be presented in a form more readable to mere mortals?

  • Access: public

Parameters:

bool   $value     defaults to true.

[ Top ]

setOutputDriver   [line 361]

void setOutputDriver( string $type)

set up driver to be used, dependant on specified type.
  • Access: public

Parameters:

string   $type     name the type of driver (html, text...)

[ Top ]

setRoundValues   [line 460]

void setRoundValues( [bool $value = true])

Should values be rounded to multiples of 1000?
  • Access: public

Parameters:

bool   $value     defaults to true

[ Top ]

setSortSize   [line 416]

void setSortSize( [bool $value = true])

Indicate whether results should be sorted by size.
  • Access: public

Parameters:

bool   $value     defaults to true.

[ Top ]

setSummarise   [line 472]

void setSummarise( [bool $value = true])

Should a summary view be displayed rather than the detailed one?
  • Access: public

Parameters:

bool   $value     defaults to true

[ Top ]

setTypes   [line 509]

void setTypes( [string $types = ''])

Set the types/roles of files that are to be searched for in each package.
  • Access: public

Parameters:

string   $types     comma seperated string containing names of types.

[ Top ]

setVerbose   [line 378]

void setVerbose( [bool $value = true])

set verbosity level

Should generated data (and the associated report) contain more information?

  • Access: public

Parameters:

bool   $value     defaults to true.

[ Top ]


Documentation generated on Thu, 05 Nov 2009 10:00:03 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.