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_Csv
PHP_CompatInfo_Renderer_Html
PHP_CompatInfo_Renderer_Null
PHP_CompatInfo_Renderer_Text
PHP_CompatInfo_Renderer_Xml
Files:
Array.php
Cli.php
CompatInfo.php
Csv.php
Html.php
Null.php
Parser.php
pci.php
Renderer.php
Text.php
Xml.php

Class: PHP_CompatInfo_Parser

Source Location: /PHP_CompatInfo-1.8.0/CompatInfo/Parser.php

Class Overview




Parser logic




Author(s):






        
                

Version:


    
  
  • Release: 1.8.0
    • 








Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 101]

Parser logic
This class is the model in the MVC design pattern of API 1.8.0 (since beta 2)









[ Top ]







Class Variables



	
	

	
$dataSource = 

	
[line 152]

  


    

  • Var: Data Source
    • 

  • Since: 1.8.0b2
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$directories = 

	
[line 159]

  





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$dispatcher = 

	
[line 119]

  Stores the event dispatcher which handles notifications


    

  • Since: 1.8.0b2
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$earliest_version =  ''

	
[line 141]

  


    

  • Var: Last version of PHP to use
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$ignored_files = array()

	
[line 166]

  





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$latest_version =  '4.0.0'

	
[line 136]

  


    

  • Var: Earliest version of PHP to use
    • 

  • Since: 0.7.0
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$options = 

	
[line 146]

  


    

  • Var: Parsing options
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$renderer = 

	
[line 110]

  Instance of concrete renderer used to show parse results


    

  • Since: 1.8.0b2
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 185]

	

    

    

		PHP_CompatInfo_Parser __construct(
)
    

    


	
		Class constructor (ZE2) for PHP5+


    

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

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
PHP_CompatInfo_Parser (Constructor)   [line 174]

	

    

    

		PHP_CompatInfo_Parser PHP_CompatInfo_Parser(
)
    

    


	
		Class constructor (ZE1) for PHP4


    

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

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
addListener   [line 226]

	

    

    

		void addListener(
mixed
$callback, [string
$nName = EVENT_DISPATCHER_GLOBAL])
    

    


	
		Registers a new listener
Registers a new listener with the given criteria.


    

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

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $callback  
        —
          A PHP callback
      

          

        string  
        $nName  
        —
          (optional) Expected notification name
      

        

    


        
[ Top ]

  

  
  
	
	
getDirlist   [line 370]

	

    

    

		array getDirlist(
mixed
$dir, array
$options)
    

    


	
		Returns list of directory parsed
Returns list of directory parsed, depending of restrictive parser options.


    

  • Return: list of directories that should be parsed
    • 

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

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $dir  
        —
          The directory name
      

          

        array  
        $options  
        —
          An array of parser options. See parseData() method.
      

        

    


        
[ Top ]

  

  
  
	
	
getFilelist   [line 391]

	

    

    

		array getFilelist(
mixed
$dir, array
$options)
    

    


	
		Returns list of files parsed
Returns list of files parsed, depending of restrictive parser options.


    

  • Return: list of files that should be parsed
    • 

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

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $dir  
        —
          The directory name where to look files
      

          

        array  
        $options  
        —
          An array of parser options. See parseData() method.
      

        

    


        
[ Top ]

  

  
  
	
	
getIgnoredFiles   [line 474]

	

    

    

		array getIgnoredFiles(
)
    

    


	
		Returns list of files ignored
Returns list of files ignored while parsing directories


    

  • Return: or false on error
    • 

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

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
loadVersion   [line 296]

	

    

    

		array loadVersion(
string
$min, [string|boolean
$max = false], [boolean
$include_const = false], [boolean
$groupby_vers = false])
    

    


	
		Load components list
Load components list for a PHP version or subset


    

  • Return: An array of php function/constant names history
    • 

  • Since: version 1.2.0 (2006-08-23)
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $min  
        —
          PHP minimal version
      

          

        string|boolean  
        $max  
        —
          (optional) PHP maximal version
      

          

        boolean  
        $include_const  
        —
          (optional) include constants list                                                  in final result
      

          

        boolean  
        $groupby_vers  
        —
          (optional) give initial php version                                                  of function or constant
      

        

    


        
[ Top ]

  

  
  
	
	
notifyListeners   [line 272]

	

    

    

		void notifyListeners(
string
$event, [array
$info = array()])
    

    


	
		Post a new notification to all listeners registered.
This notification occured only if a dispatcher exists. That means if  at least one listener was registered.


    

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

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $event  
        —
          Name of the notification handler
      

          

        array  
        $info  
        —
          (optional) Additional information about the notification
      

        

    


        
[ Top ]

  

  
  
	
	
parseData   [line 528]

	

    

    

		array parseData(
mixed
$dataSource, [array
$options = array()])
    

    


	
		Parse a data source
Parse a data source with auto detect ability. This data source, may be  one of these follows: a directory, a file, a string (chunk of code),  an array of multiple origin.
Each of five parsing functions support common and specifics options.
* Common options : 
  • 'debug'                   Contains a boolean to control whether
                              extra ouput is shown.
  • 'ignore_functions'        Contains an array of functions to ignore
                              when calculating the version needed.
  • 'ignore_constants'        Contains an array of constants to ignore
                              when calculating the version needed.
  • 'ignore_extensions'       Contains an array of php extensions to ignore
                              when calculating the version needed.
  • 'ignore_versions'         Contains an array of php versions to ignore
                              when calculating the version needed.
  • 'ignore_functions_match'  Contains an array of function patterns to ignore
                              when calculating the version needed.
  • 'ignore_extensions_match' Contains an array of extension patterns to ignore
                              when calculating the version needed.
  • 'ignore_constants_match'  Contains an array of constant patterns to ignore
                              when calculating the version needed.
   * parseArray, parseDir|parseFolder, specific options : 
  • 'file_ext'                Contains an array of file extensions to parse
                              for PHP code. Default: php, php4, inc, phtml
  • 'ignore_files'            Contains an array of files to ignore.
                              File names are case insensitive.
   * parseArray specific options : 
  • 'is_string'               Contains a boolean which says if the array values
                              are strings or file names.
   * parseDir|parseFolder specific options : 
  • 'recurse_dir'             Boolean on whether to recursively find files
  • 'ignore_dirs'             Contains an array of directories to ignore.
                              Directory names are case insensitive.


    

  • Return: or false on error
    • 

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

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $dataSource  
        —
          The data source (may be file, dir, string, or array)
      

          

        array  
        $options  
        —
          An array of options. See above.
      

        

    


        
[ Top ]

  

  
  
	
	
removeListener   [line 246]

	

    

    

		bool removeListener(
mixed
$callback, [string
$nName = EVENT_DISPATCHER_GLOBAL])
    

    


	
		Removes a registered listener
Removes a registered listener that correspond to the given criteria.


    

  • Return: True if listener was removed, false otherwise.
    • 

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

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $callback  
        —
          A PHP callback
      

          

        string  
        $nName  
        —
          (optional) Expected notification name
      

        

    


        
[ Top ]

  

  
  
	
	
setOutputDriver   [line 209]

	

    

    

		void setOutputDriver(
string
$type, [array
$conf = array()])
    

    


	
		Set up driver to be used
Set up driver to be used, dependant on specified type.


    

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

  • Access: public
    • 








        
Parameters:

    

    

          

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

          

        array  
        $conf  
        —
          A hash containing any additional configuration
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Fri, 01 Aug 2008 11:30:30 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright ©  PHP Group 2004.