phpDocumentor and PEAR - interesting crossing of paths

Tuesday, May 2. 2006

phpDocumentor and PEAR - interesting crossing of paths

Yesterday and today I released phpDocumentor 1.3.0RC6. Aside from a number of exciting features and many important bug fixes, including some bugs opened over 2 years ago (!) this release is unique in another way: in addition to working as a PEAR-installable package, it also works as an extracted file.

This is a subtle but revolutionary change. In order to do this, we have to take advantage of some interesting possibilities that package.xml 2.0 provides. In fact, I designed several of the features of package.xml 2.0 to support this duality. In particular, it is possible to bundle a file and completely ignore it. We use this feature to handle the duality of the "phpdoc" command itself.

When installed through PEAR, a file named "pear-phpdoc" is installed as "phpdoc", and if installed on windows, "pear-phpdoc.bat" is installed as "phpdoc.bat." Also bundled in the archive are the original "phpdoc" and "phpdoc.bat" commands needed to run phpDocumentor out of the box just by extracting the archive. These files are simply ignored by the PEAR installer.

Another feature unique to package.xml 2.0 that makes this possible is the usage of package-time file tasks. In particular, the replace task, which is used to set the version of phpDocumentor as displayed by the actual generation and the docbuilder web interface.

In addition, I finally updated the manual at http://www.phpdoc.org/manual to the current version.

So in short, things are coming together finally.

Posted by Greg Beaver in PEAR, phpDocumentor at 14:31 | Comments (2) | Trackbacks (0)

Trackbacks

Trackback specific URI for this entry

No Trackbacks

Comments

Display comments as (Linear | Threaded)

I have following question on upgrading phpDocumentor:

During first installation of phpDocumentor you are encouraged to change temporarily data-dir to get gui working on localhost.
If I now upgrade phpDocumentor do I have again change data-dir before or is the information, where gui of phpDocumentor already exists, stored somewhere locally?

#1 Magkes on 2006-05-02 16:11 (Reply)

The data_dir persists from time to time, so unless you explicitly change it back with

pear config-set data_dir something/else

it will be the same when you upgrade phpDocumentor.

Good question!

#1.1 Greg Beaver (Homepage) on 2006-05-02 20:27 (Reply)

Add Comment

Name
Email
Homepage
In reply to
Comment	Standard emoticons like :-) and ;-) are converted to images. E-Mail addresses will not be displayed and will only be used for E-Mail notifications To prevent automated Bots from commentspamming, please enter the string you see in the image below in the appropriate input box. Your comment will only be submitted if the strings match. Please ensure that your browser supports and accepts cookies, or your comment cannot be verified correctly. Enter the string from the spam-prevention image above: BBCode format allowed You can use [geshi lang=lang_name [,ln={y\|n}]][/lang] tags to embed source code snippets
	Remember Information? Subscribe to this entry
Submitted comments will be subject to moderation before being displayed.