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


Classes:
PEAR_Command_Size
PEAR_Size
PEAR_Size_CLI
PEAR_Size_Exception
PEAR_Size_HTML_Table
PEAR_Size_OutputFactory
PEAR_Size_Output_CSV
PEAR_Size_Output_Driver
PEAR_Size_Output_Html
PEAR_Size_Output_Text
PEAR_Size_Output_XML
Files:
CLI.php
csv.php
Exception.php
Factory.php
html.php
pearsize.php
Size.php
Size.php
text.php
xml.php

Class: PEAR_Size

Source Location: /PEAR_Size-1.0.0RC1/PEAR/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 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 203]

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

	

    

    

		void __construct(
)
    

    


	
		Class constructor


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
analyse   [line 603]

	

    

    

		void analyse(
)
    

    


	
		Main analysis method


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
generateReport   [line 696]

	

    

    

		void generateReport(
)
    

    


	
		Generate the report


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
parseCLIOptions   [line 531]

	

    

    

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

	

    

    

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

	

    

    

		void setAllChannels(
[bool
$mode = true])
    

    


	
		Set variables for analysing all channels.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $mode  
        — 
        defaults to true.
      

        

    


        
[ Top ]

  

  
  
	
	
setChannel   [line 491]

	

    

    

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

	

    

    

		void setDontDisplayZeroValues(
[bool
$value = false])
    

    


	
		Should the driver display/include zero values.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $value  
        — 
        defaults to false.
      

        

    


        
[ Top ]

  

  
  
	
	
setHumanReadable   [line 399]

	

    

    

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

	

    

    

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

	

    

    

		void setRoundValues(
[bool
$value = true])
    

    


	
		Should values be rounded to multiples of 1000?


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $value  
        — 
        defaults to true
      

        

    


        
[ Top ]

  

  
  
	
	
setSortSize   [line 423]

	

    

    

		void setSortSize(
[bool
$value = true])
    

    


	
		Indicate whether results should be sorted by size.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $value  
        — 
        defaults to true.
      

        

    


        
[ Top ]

  

  
  
	
	
setSummarise   [line 479]

	

    

    

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

	

    

    

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

	

    

    

		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 16:03:05 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.