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

Class: PEAR_Size

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

Class Overview


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


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2008 Ken Guest

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

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


[ Top ]


Class Variables

$errors = array()

[line 114]

array or PEAR_Error of error messages
  • Access: public

Type:   array


[ Top ]

$reg =  null

[line 160]

Registry object
  • Access: protected

Type:   Registry


[ Top ]

$reg_channels = array()

[line 153]

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

Type:   array


[ Top ]

$search_roles =  ''

[line 176]

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 ]



Method Detail

__construct (Constructor)   [line 371]

void __construct( )

class constructor
  • Access: public

[ Top ]

analyse   [line 603]

void analyse( )

main analysis method
  • Access: public

[ Top ]

generateReport   [line 654]

void generateReport( )

generate the report
  • Access: public

[ Top ]

parseCLIOptions   [line 553]

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 472]

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 482]

void setAllChannels( [ $mode = true])

set variables for analysing all channels.
  • Access: public

Parameters:

   $mode   — 

[ Top ]

setChannel   [line 515]

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 ]

setHumanReadable   [line 448]

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 417]

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 502]

void setRoundValues( [bool $value = true])

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

Parameters:

bool   $value   —  defaults to true

[ Top ]

setSortSize   [line 460]

void setSortSize( [bool $value = true])

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

Parameters:

bool   $value   —  defaults to true.

[ Top ]

setTypes   [line 540]

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 434]

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 Mon, 11 Mar 2019 15:17:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.