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


Classes:
PHP_CompatInfo
PHP_CompatInfo_Cli
PHP_CompatInfo_Parser
PHP_CompatInfo_Renderer
PHP_CompatInfo_Renderer_Array
PHP_CompatInfo_Renderer_Null
PHP_CompatInfo_Renderer_Text
PHP_CompatInfo_Renderer_Xml
Files:
Array.php
Cli.php
CompatInfo.php
Null.php
Parser.php
pci.php
Renderer.php
Text.php
Xml.php

Class: PHP_CompatInfo_Renderer

Source Location: /PHP_CompatInfo-1.8.0b3/CompatInfo/Renderer.php

Class Overview




Base class used by all renderers




Author(s):






        
                    

Version:


    
  
  • Release: 1.8.0b3
    • 








Variables






Methods















Child classes:






PHP_CompatInfo_Renderer_Xml

	
The PHP_CompatInfo_Renderer_Xml class is a concrete implementation  of PHP_CompatInfo_Renderer abstract class. It simply display results as  an XML stream.






PHP_CompatInfo_Renderer_Null

	
The PHP_CompatInfo_Renderer_Null class is a concrete implementation  of PHP_CompatInfo_Renderer abstract class. It simply consumes output events.






PHP_CompatInfo_Renderer_Text

	
The PHP_CompatInfo_Renderer_Text class is a concrete implementation  of PHP_CompatInfo_Renderer abstract class. It simply display results  for the command line interface with help of PEAR::Console_Table






PHP_CompatInfo_Renderer_Array

	
The PHP_CompatInfo_Renderer_Array class is a concrete implementation  of PHP_CompatInfo_Renderer abstract class. It simply display results as  a PHP array.









Inherited Variables





Inherited Methods














Class Details



[line 34]

Base class used by all renderers









[ Top ]







Class Variables



	
	

	
$eol = 

	
[line 55]

  


    

  • Var: End of line string (depending of server API)
    • 

  • Access: public
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$parseData = 

	
[line 71]

  Data source parsed final results


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$silent = 

	
[line 63]

  Silent mode. Display or not extra info messages.


    

  • Access: public
    • 





  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 96]

	

    

    

		PHP_CompatInfo_Renderer __construct(
object
&$parser, array
$conf)
    

    


	
		Base Renderer Class constructor (ZE2) for PHP5+


    

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
PHP_CompatInfo_Renderer_Xml::__construct()

		
Xml Renderer Class constructor (ZE2) for PHP5+

	

		

	
PHP_CompatInfo_Renderer_Null::__construct()

		
Null Renderer Class constructor (ZE2) for PHP5+

	

		

	
PHP_CompatInfo_Renderer_Text::__construct()

		
Text Renderer Class constructor (ZE2) for PHP5+

	

		

	
PHP_CompatInfo_Renderer_Array::__construct()

		
Array Renderer Class constructor (ZE2) for PHP5+

	

	


        
Parameters:

    

    

          

        object  
        &$parser  
        — 
        Instance of the parser (model of MVC pattern)
      

          

        array  
        $conf  
        — 
        A hash containing any additional configuration
      

        

    


        
[ Top ]

  

  
  
	
	
PHP_CompatInfo_Renderer (Constructor)   [line 82]

	

    

    

		PHP_CompatInfo_Renderer PHP_CompatInfo_Renderer(
object
&$parser, array
$conf)
    

    


	
		Base Renderer Class constructor (ZE1) for PHP4


    

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        &$parser  
        — 
        Instance of the parser (model of MVC pattern)
      

          

        array  
        $conf  
        — 
        A hash containing any additional configuration
      

        

    


        
[ Top ]

  

  
  
	
	
endWaitProgress   [line 302]

	

    

    

		void endWaitProgress(
)
    

    


	
		Finish waiting process
Finish waiting process, by erasing the progress bar


    

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
factory   [line 169]

	

    

    

		object PHP_CompatInfo_Renderer &factory(
object
&$parser, [string
$type = 'array'], [array
$conf = array()])
    

    


	
		Create required instance of the Output 'driver'.


    

  • Return: A concrete PHP_CompatInfo_Renderer                                         instance, or null on error.
    • 

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object  
        &$parser  
        — 
        A concrete instance of the parser
      

          

        string  
        $type  
        — 
        (optional) Type of instance required, lowercase.
      

          

        array  
        $conf  
        — 
        (optional) A hash containing any additional                         configuration information that a subclass might need.
      

        

    


        
[ Top ]

  

  
  
	
	
isIncludable   [line 323]

	

    

    

		boolean isIncludable(
string
$file)
    

    


	
		Returns whether or not a file is in the include path


    

  • Return: True if the file is in the include path, false otherwise
    • 

  • Since: version 1.7.0b4 (2008-04-03)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $file  
        — 
        Path to filename to check if includable
      

        

    


        
[ Top ]

  

  
  
	
	
startWaitProgress   [line 243]

	

    

    

		void startWaitProgress(
integer
$maxEntries)
    

    


	
		Initialize the wait process
Initialize the wait process, with a simple message or a progress bar.


    

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $maxEntries  
        — 
        Number of source to parse
      

        

    


        
[ Top ]

  

  
  
	
	
stillWaitProgress   [line 274]

	

    

    

		void stillWaitProgress(
string
$source, string
$index)
    

    


	
		Update the wait message
Update the wait message, or status of the progress bar


    

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $source  
        — 
        Source (file, string) currently parsing
      

          

        string  
        $index  
        — 
        Position of the $source in the data source list                        to parse
      

        

    


        
[ Top ]

  

  
  
	
	
update   [line 204]

	

    

    

		void update(
object
&$auditEvent)
    

    


	
		Interface to update the view with current information
Listen events produced by Event_Dispatcher and the PHP_CompatInfo_Parser


    

  • Since: version 1.8.0b2 (2008-06-03)
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
PHP_CompatInfo_Renderer_Null::update()

		
Consumes output events

	

	


        
Parameters:

    

    

          

        object  
        &$auditEvent  
        — 
        Instance of Event_Dispatcher
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:22:50 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.