File: create_package.xml.php

Source Location: /PhpDocumentor-1.2.0beta2/scripts/create_package.xml.php

Classes:

Page Details:

PEAR Package.xml file generator

Version: 0.1
Copyright: Copyright 2002, Greg Beaver
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

Includes:

require_once("../phpDocumentor/common.inc.php") [line 16]
phpDocumentor include files. If you don't have phpDocumentor, go get it!

Your php life will be changed forever

require_once("../phpDocumentor/Io.inc") [line 17]
phpDocumentor include files. If you don't have phpDocumentor, go get it!

Your php life will be changed forever

string $baseinstalldir [line 115]

PEAR-relative install dir, used as attribute for <dir name="/">

Default value:

'PhpDocumentor'

[ Top ]

string $date [line 31]

Default value:

date('Y-m-d')

[ Top ]

array $dir_roles [line 142]

Mapping of subdirectory names to the role attribute of the <dir> tag

Default value:

array
            (
               'spec' => 'doc',
               'tests' => 'test',
               'Release-old' => 'doc',
               'user' => 'php',
               'templates' => 'php',
                    'templates_c' => 'php',
            )

[ Top ]

array $exceptions [line 157]

Mapping of filenames to roles for files that don't fit the normal

$roles

Default value:

array
            (
                    'index.html' => 'php',
                    'INSTALL' => 'doc',
               'README' => 'doc',
                    'FAQ' => 'doc',
               'ChangeLog' => 'doc',
               'makedoc.sh' => 'php',
                    'pear_phpdoc' => 'script',
               'Release-1.2.0' => 'doc',
               'Release-1.1.0' => 'doc',
               'Release-1.1.0rc1' => 'doc',
               'Release-1.1.0rc2' => 'doc',
                    'Release-1.2.0beta1' => 'doc'
            )

[ Top ]

Io $files [line 185]

Default value:

new <a href="../phpDocumentor/Io.html">Io</a>

[ Top ]

string $ignore [line 123]

Comma-separated list of files and directories to ignore

This uses wildcards * and ? to remove extra files/directories that are not part of the package or release

Default value:

array('CVS/','package.xml','*.tgz','test.php','.*','*.apf','greg.ini','Beautifier*','xhtmlcss/','templates_c/','pear.php','phpdoc')

[ Top ]

string $notes [line 35]

Default value:

<<< EOF
The phpDocumentor team would like to announce the release of phpDocumentor
1.2.0 BETA 2.  This is a beta release and may have bugs and may have a different
structure from the final release

The phpDocumentor team would like to announce the release of phpDocumentor
1.2.0 BETA 2.  This is a beta release and may have bugs and may have a different
structure from the final release.  This beta differs from 1.2.0Beta in that it
should work from pear install PhpDocumentor, and has a few bugs fixed and a few
extra features.

phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
written in PHP.  It is the most versatile tool for documenting PHP.

Once again, phpDocumentor brings a great increase in usability with the 1.2
branch.  The addition of a tokenizer-based parser increases parsing speed by
up to 4 times (that's 400% faster) compared to previous versions.  In addition,
scalability has been improved, allowing generation of documents in multiple
output formats with one command.  The usage of config files makes repetitive
parsing tasks straightforward and reduces the chance for error.

The addition of DocBlock templates, extended documentation (tutorials) parsing,
and many other new features make this release the most useful automatic
documentor for any programming language.

The default HTML Converter has been ported to a new Smarty-based converter,
HTMLframesConverter, and all of the old templates have been ported to the new
Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
functionality is redundant.  Due to the time it takes to convert a template to
the new format, the phpDocumentor team extends an offer to do this conversion
for anyone who has a brand new template.  We may also include the template in a
future release, if permission is granted.

Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
converter with peardoc2 templates.  This converter could also generate other
DocBook formats, if desired, but does not generate indexing for this release.

The PDF Converter has stepped up to beta-quality, is fully templatable, and
has most bugs completely fixed.  The CHM converter has also taken major strides
and is close to beta quality.

As predicted, the Smarty template engine is the primary template engine for
all converters.

For users new to phpDocumentor, phpDocumentor uses an event-driven parser
and intermediary data structures that allow it to perform at a level other
automatic documentors for PHP cannot achieve:
  --parsing any php file, with multiple classes and functions in the same file
  --fully compliant with even the most esoteric php syntax
     (\$string = <<< EOF, for example)
  --ability to generate multiple output formats
  --extremely fast parsing
  --error/warnings by line number and file to allow for debugging of
   documentation tags
  --multiple output templates to easily customize the look of generated
   documentation
  --extensive documentation of the package, including a detailed specification
   for tags and the included template engine
  --open source, GPL


A full listing of all closed bugs and feature requests can be found in the
next section of the notes

phpDocumentor 1.2.0BETA2 is not ready for production use documenting any PHP
project, although it is very stable.  Download it and try the most advanced
solution for PHP documentation today to help us find the last persistent bugs.
There are MANY in the new XML DocBook Converter.  Please try it out and find
them so we can begin to fix them.  HTML Converters are both very stable, as is
the Parser.

EOF

[ Top ]

string $package_directory [line 110]

Physical location on this computer of the package to parse

Default value:

'C:/Web Pages/chiara/phpdoc'

[ Top ]

array $roles [line 130]

Mapping of file extensions to the role attribute of the <file> tag

'*' is the default role for files with no extension or extensions not shown

Default value:

array
         (
            'php' => 'php',
            'inc' => 'php',
            'html' => 'doc',
            '*' => 'php',
         )

[ Top ]

string $state [line 27]

Default value:

"beta"

[ Top ]

string $version [line 23]

Default value:

"1.2.0beta2"

[ Top ]

boolean $webinterface [line 181]

Determines whether output is made html-friendly or not

Default value:

isset($_SERVER['PATH_TRANSLATED'])

[ Top ]

getDirTag [line 256]

void getDirTag(
array $struc, [false|string $role = false], [integer $level = 0])

Recursively generate the <filelist> section's <dir> and <file> tags

Global: array $dir_roles: directory roles
Global: array $exceptions: exceptions to standard file roles
Global: array $roles: standard file roles
Global: string $baseinstalldir: base installation directory

Parameters

array	$struc	the sorted directory structure
false\|string	$role	whether the parent directory has a role this should inherit
integer	$level	indentation level

[ Top ]

mystrucsort [line 198]

void mystrucsort(
string $a, string $b)

Sorting functions for the file list

Parameters

string	$a
string	$b

[ Top ]

sortfiles [line 193]

void sortfiles(
string $a, string $b)

Sorting functions for the file list

Parameters

string	$a
string	$b

[ Top ]