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


Classes:
PEAR_Info
PEAR_Info_Cli
Files:
Cli.php
Info.php

Class: PEAR_Info

Source Location: /PEAR_Info-1.9.2/Info.php

Class Overview




The PEAR_Info class generate phpinfo() style PEAR information.




Author(s):






            
                

Version:


    
  
  • Release: @package_version@
    • 








Variables






Methods















Child classes:






PEAR_Info_Cli

	
CLI Script to display information about your PEAR installation









Inherited Variables





Inherited Methods














Class Details



[line 133]

The PEAR_Info class generate phpinfo() style PEAR information.









[ Top ]







Class Variables



	
	

	
$cfg = 

	
[line 169]

  Alternative config files


    

  • Since: 1.9.0
    • 

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$config = 

	
[line 160]

  instance of PEAR_config


    

  • Since: 1.0.1
    • 

  • Access: public
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$css = 

	
[line 151]

  Style sheet for the custom layout


    

  • Since: 1.7.0RC1
    • 

  • Access: public
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$info = 

	
[line 142]

  Html code for phpinfo() style PEAR information


    

  • Since: 1.0.1
    • 

  • Access: public
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$reg = 

	
[line 178]

  instance of PEAR_Registry


    

  • Since: 1.0.1
    • 

  • Access: public
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]










Method Detail



	
	
PEAR_Info (Constructor)   [line 194]

	

    

    

		void PEAR_Info(
[string
$pear_dir = ''], [string
$user_file = ''], [string
$system_file = ''], [array
$options = null])
    

    


	
		PHP 4 style constructor (ZE1)


    

  • Since: version 1.0.1 (2003-04-24)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $pear_dir  
        —
          (optional) The PEAR base install directory
      

          

        string  
        $user_file  
        —
          (optional) file to read PEAR user-defined                             options from
      

          

        string  
        $system_file  
        —
          (optional) file to read PEAR system-wide                             defaults from
      

          

        array  
        $options  
        —
          (optional) configure PEAR information output
      

        

    


        
[ Top ]

  

  
  
	
	
display   [line 1402]

	

    

    

		void display(
)
    

    


	
		Displays PEAR_Info output
Displays PEAR_Info output depending of style applied (style sheet).








        
[ Top ]

  

  
  
	
	
getMembers   [line 1339]

	

    

    

		array getMembers(
[string
$group = 'all'], [bool
$sort = true])
    

    


	
		Returns a members list depending of its category (group, docs, website)
Retrieve the members list of PEAR group, PEAR doc team, or PEAR website team


    

  • Since: version 1.7.0RC3 (2007-07-10)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $group  
        —
          (optional) Member list category.                       Either president, group, docs or website
      

          

        bool  
        $sort  
        —
          (optional) Return a member list sorted                       in alphabetic order
      

        

    


        
[ Top ]

  

  
  
	
	
getStyleSheet   [line 457]

	

    

    

		string getStyleSheet(
[bool
$content = true])
    

    


	
		Returns the custom style sheet to use for presentation
Default behavior is to return css string contents.  Sets $content parameter to false will return css filename reference  (defined by setStyleSheet function).  Easy for a <link rel="stylesheet" type="text/css" href="" />  html tag integration (see example pear_info3.php).


    

  • Since: version 1.7.0RC1 (2007-07-01)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $content  
        —
          (optional) Either return css filename or string contents
      

        

    


        
[ Top ]

  

  
  
	
	
packageInstalled   [line 1475]

	

    

    

		bool packageInstalled(
string
$name, [string
$version = null], [string
$channel = null], [string
$user_file = ''], [string
$system_file = ''])
    

    


	
		Check if a package is installed
Simple function to check if a package is installed under user  or system PEAR installation. Minimal version and channel info are supported.


    

  • Since: version 1.6.0 (2005-01-03)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        —
          Package name
      

          

        string  
        $version  
        —
          (optional) The minimal version                             that should be installed
      

          

        string  
        $channel  
        —
          (optional) The package channel distribution
      

          

        string  
        $user_file  
        —
          (optional) file to read PEAR user-defined                             options from
      

          

        string  
        $system_file  
        —
          (optional) file to read PEAR system-wide                             defaults from
      

        

    


        
[ Top ]

  

  
  
	
	
pearImage   [line 1291]

	

    

    

		void pearImage(
)
    

    


	
		Display the PEAR logo
Display the PEAR logo (gif image) on browser output


    

  • Since: version 1.0.1 (2003-04-24)
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setProxy   [line 436]

	

    

    

		bool setProxy(
string
$proxy)
    

    


	
		Sets PEAR HTTP Proxy Server Address
Sets http_proxy config setting at runtime


    

  • Since: version 1.0.6 (2003-05-11)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $proxy  
        —
          PEAR HTTP Proxy Server Address
      

        

    


        
[ Top ]

  

  
  
	
	
setStyleSheet   [line 479]

	

    

    

		bool setStyleSheet(
[string
$css = null])
    

    


	
		Sets the custom style sheet to use your own styles
Sets the custom style sheet (colors, sizes) to applied to PEAR_Info output.  If you don't give any parameter, you'll then apply again the default style.


    

  • Return: True if custom styles, false if default styles applied
    • 

  • Since: version 1.7.0RC1 (2007-07-01)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $css  
        —
          (optional) File to read user-defined styles from
      

        

    


        
[ Top ]

  

  
  
	
	
show   [line 1387]

	

    

    

		void show(
)
    

    


	
		Shows PEAR_Info output
Displays PEAR_Info output depending of style applied (style sheet).








        
[ Top ]

  

  
  
	
	
toHtml   [line 1419]

	

    

    

		string toHtml(
)
    

    


	
		Returns PEAR_Info output (html code)
Returns html code. This code is XHTML 1.1 compliant since version 1.7.0  A stand-alone HTML page will be printed only if PEAR_INFO_FULLPAGE  resume options is set.








        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Thu, 19 Feb 2009 18:30:04 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright ©  PHP Group 2004.