PHP_CompatInfo 1.9.0

Laurent Laville

pear@laurent-laville.org

December 26, 2008

Agenda

• Project History
• Credits
• Why a new API ?
• News in API 1.9.0
• Your Extensions Support List (how to build it)

Project History (1/3)

• Marth 2004 Davey Shafik, original and first developper of PEAR::PHP_CompatInfo, released the first alpha version.
• Marth 2005 One year after, Davey released the first stable API 1.0.0 that detect PHP3 and PHP4 code.

Project History (2/3)

• June - July 2006 I (Laurent Laville) became the new leader in development of this great package. I've introduced a better support of Extension and PHP5 detection in version 1.1.0
• November 2007 Version 1.5.0 announce the drop of PHP3 support detection.
• May - August 2008 With introduction of a new API 1.8.0 (code rewrites to follow the MVC pattern), PHP_CompatInfo open output to multiple format (CSV, XML, HTML, Text, Array), and add a better support to conditional code.

Project History (3/3)

• November - December 2008 I'm happy to present the new API 1.9.0 that will allow to improve code detection especially for classes and constants implemented by PHP extensions.

Credits

Special thanks to Davey Safik, without who this adventure won't became a reality.

Thanks also to Christian Weiske, without who and his bug report, API 1.9.0 won't certainly born.

Why a new API ?

With API 1.8.0, there is a limitation in class (internal, and end-user defined) detection. This limitation is also valuable for lot of constants and PHP extensions.

As always, my goal was to keep a backward compatibility with previous versions, and add a simple way to support easily the ton of possible PHP extensions with their constants and classes implementation.

I thought since a long time to rewrite the full package in PHP5 with help of Reflection API, but I've not yet reached the limitation of PHP4 code.

News in API 1.9.0 (1/3)

• Add aliases functions to easily get information from global array result return by parsing functions. All or partially (for a file when data source is a directory or an array).
  • Minimum (and or maximal) PHP Version with getVersion()
  • All classes (internal or end-user defined) with getClasses()
  • All functions (internal or end-user defined) with getFunctions()
  • All extensions (internal or external) with getExtensions()
  • All constants (internal or end-user defined) with getConstants()
  • All PHP5+ tokens with getTokens()
  • All code conditions with getConditions()

News in API 1.9.0 (2/3)

• Add aliases functions to easily get ignored elements from global array result return by parsing functions.
  • All files with getIgnoredFiles()
  • All functions (internal or end-user defined) with getIgnoredFunctions()
  • All extensions (internal or external) with getIgnoredExtensions()
  • All constants (internal or end-user defined) with getIgnoredConstants()

News in API 1.9.0 (3/3)

• Add a new CLI script (pciconf) to help PHP5 end-users to build their own Extension Support List.

Your Extensions Support List (1/7)

As I can't imagine to provide all possible extensions support, I've added a basic list by default (see CompatInfo/func_array.php file), and let ability to :

• PHP5 end-users to generate their own list with the pciconf CLI script.
• PHP4 end-users to make their own list by editing files: func_array.php, class_array.php, const_array.php

Your Extensions Support List (2/7)

The pciconf CLI script, presented here, is for PHP5 users only.

PHP_CompatInfo Extensions Support List build system
Usage: pciconf [options]

-e --enable (optional)value      A comma separated list of extensions you want
                                 only ()
-d --disable (optional)value     A comma separated list of extensions you want
                                 to disable ()
-s --sapi (optional)value        A comma separated list of SAPI you want only
                                 (apache2handler,cgi,cli)
-x --exceptions (optional)value  File that provides exceptions results
                                 (exceptions.conf.php)
-o --output (optional)value      Target directory where to write results
                                 (@php_dir@/PHP/CompatInfo)
-v --verbose (optional)value     Set the verbose level (1)
-V --version                     Print version information
-h --help                        Show this help
      

Your Extensions Support List (3/7)

Default behavior of pciconf is to build the full list of all extensions loaded on current platform.

• You may limit the full list to a simple one with --enable

  pciconf --enable standard,date,xsl
          

• You may exclude some extensions of the full list with --disable

  pciconf --disable xdebug
          

Your Extensions Support List (4/7)

Default behavior of pciconf is to build common server API support (apache2handler, cgi, cli).

• You may generate other Server API with --sapi

  pciconf --sapi nsapi,cli
          

Your Extensions Support List (5/7)

Default behavior of pciconf is to build results in the same directory where PHP_CompatInfo was installed (@php_dir@/PHP/CompatInfo).

• If don't want to overwrite default PHP_CompatInfo installation, you should tell where to write results with --output

  pciconf --output /tmp
          

• You may use the PEAR config variable php_dir with template '@php_dir@'

  pciconf --output @php_dir@/../includes/PHP/CompatInfo
          

Your Extensions Support List (6/7)

pciconf has ability to fix errors (like elements missing, or wrong version) with the Exception Rules System.

This ERS is provided by a file (default is exception.conf.php) with a mandatory function named getException().

• You can provide your own rules by telling where is this ERS file with --exceptions

  pciconf --exceptions /home/users/farell/myERS.php
          

Your Extensions Support List (7/7)

pciconf run in verbose mode (by default). Thats means you should have on screen what extensions (and which versions) were found.

• You can run pciconf in silent mode with --verbose

  pciconf --verbose 0
          

The End

Thank you for your attention!

Hope you liked it!

ANY QUESTIONS ?

Do you have feedback, suggestions, critics?

Don't hesitate to ask to improve this new API before stable release, planned on January 19, 2009.