Home | About Chris Hope | Contact Chris Hope | Search:

PHP PEAR DB Code Completion in Zend Studio

Posted November 2nd, 2007 in PHP

The PEAR DB library provides a database abstraction library for PHP, along with many other useful functions for running database queries. There are a number of other database abstraction libraries for PHP, such as ADODB and ADODB Lite.

PHP editors such as Zend Studio (previously known as the Zend Development Environment), PHP Eclipse or Nusphere to name a few, have code completion built into them, so when you start typing in a function or method name, popup tips help you to know what functions are available, and what parameters need to be passed to them. I use Zend Studio for progamming in PHP, and find code completion invaluable. It saves a lot of time and makes me more efficient at programming.

When using the PEAR DB library, if you want to enable code completion for these database functions, you need to add PHPDOC syntax to the top of your function call like in the example below:

/**
 * @param DB_common $db
 */
function foo(&$db) {

The @param DB_common $db part tells Zend Studio that all references to $db in the function below are of the DB_common type. This will enable code completion for this variable, so when you type in $db-$gt; the code completion dialog will pop up with the possible method calls and available variables.

This is shown in the example screenshot below:

I have only tested this in Zend Studio, but the principle should be the same for other development environments which support code completed. It will also work for other database abstraction libraries; it's just a matter of working out what the class name is for the PHPDoc code block.