Classe: PEAR_PackageFileManager  - X-Ref

PEAR :: PackageFileManager updates the <filelist></filelist> section
of a PEAR package.xml file to reflect the current files in
preparation for a release.

The PEAR_PackageFileManager class uses a plugin system to generate the
list of files in a package.  This allows both standard recursive
directory parsing (plugin type file) and more intelligent options
such as the CVS browser {@link PEAR_PackageFileManager_Cvs}, which
grabs all files in a local CVS checkout to create the list, ignoring
any other local files.

Other options include specifying roles for file extensions (all .php
files are role="php", for example), roles for directories (all directories
named "tests" are given role="tests" by default), and exceptions.
Exceptions are specific pathnames with * and ? wildcards that match
a default role, but should have another.  For example, perhaps
a debug.tpl template would normally be data, but should be included
in the docs role.  Along these lines, to exclude files entirely,
use the ignore option.

Required options for a release include version, baseinstalldir, state,
and packagedirectory (the full path to the local location of the
package to create a package.xml file for)

Example usage:
<code>
<?php
require_once('PEAR/PackageFileManager.php');
$packagexml = new PEAR_PackageFileManager;
$e = $packagexml->setOptions(
array('baseinstalldir' => 'PhpDocumentor',
'version' => '1.2.1',
'packagedirectory' => 'C:/Web Pages/chiara/phpdoc2/',
'state' => 'stable',
'filelistgenerator' => 'cvs', // generate from cvs, use file for directory
'notes' => 'We\'ve implemented many new and exciting features',
'ignore' => array('TODO', 'tests/'), // ignore TODO, all files in tests/
'installexceptions' => array('phpdoc' => '/*'), // baseinstalldir ="/" for phpdoc
'dir_roles' => array('tutorials' => 'doc'),
'exceptions' => array('README' => 'doc', // README would be data, now is doc
'PHPLICENSE.txt' => 'doc'))); // same for the license
if (PEAR::isError($e)) {
echo $e->getMessage();
die();
}
$e = $test->addPlatformException('pear-phpdoc.bat', 'windows');
if (PEAR::isError($e)) {
echo $e->getMessage();
exit;
}
$packagexml->addRole('pkg', 'doc'); // add a new role mapping
if (PEAR::isError($e)) {
echo $e->getMessage();
exit;
}
// replace @PHP-BIN@ in this file with the path to php executable!  pretty neat
$e = $test->addReplacement('pear-phpdoc', 'pear-config', '@PHP-BIN@', 'php_bin');
if (PEAR::isError($e)) {
echo $e->getMessage();
exit;
}
$e = $test->addReplacement('pear-phpdoc.bat', 'pear-config', '@PHP-BIN@', 'php_bin');
if (PEAR::isError($e)) {
echo $e->getMessage();
exit;
}
// note use of {@link debugPackageFile()} - this is VERY important
if (isset($_GET['make']) || (isset($_SERVER['argv'][2]) &&
$_SERVER['argv'][2] == 'make')) {
$e = $packagexml->writePackageFile();
} else {
$e = $packagexml->debugPackageFile();
}
if (PEAR::isError($e)) {
echo $e->getMessage();
die();
}
?>
</code>

In addition, a package.xml file can now be generated from
scratch, with the usage of new options package, summary, description, and
the use of the {@link addMaintainer()} method