phpBugTracker
Prev |  | Next

# Chapter 3. Developer's Guide

> Adding on to or extending phpBugTracker should be easy for those with a knowledge of PHP and SQL. New developers are always welcome to join the project at http://www.sourceforge.net/projects/phpbt, or to simply submit patches, bug reports, or feature requests.

# 3.1. What's where?

Following is a list of the PHP files that make up phpBugTracker and the functionality contained within them:

- `attachment.php`

  Adding, deleting, and viewing attachment information.

- `bug.php`

  Adding, displaying, and editing bugs. This includes the detailed view of a bug, printable view, bug history, a view of the votes for a bug, and the code that emails users about bug changes.

- `config-dist.php`

  This file is used as a template for generating the configuration file during installation.

- `config.php`

  This file is empty in the distribution package. When phpBugTracker has been installed this is the main configuration file that contains the table name definitions and includes the required packages.

- `include.php`

  This file is included by every other script at page load, and contains page set-up such as creating the database connection, initializing the template object, and doing authentication checks.

- `install.php`

  This file is used during the installation process to gather configuration information from the user and to set up the database.

- `logout.php`

  This is used to end the user's session.

- `newaccount.php`

  The code for creating new accounts and emailing accout information to new sers is located here.

- `query.php`

  The bug search form is rendered and handled by this script, along with the resulting list of bugs from a query.

- `report.php`

  Various summary reports.

- `upgrade.php`

  Used when upgrading to a new verison of phpBugTracker. This file is changed with every release to include (mainly) the database queries required to upgrade the installation to the latest version.

- `user.php`

  User preferences and password changes are handled via this script.

- `admin/*.php`

  Each of these files handles a segment of the adminsitration. That is, `group.php` handles all the group adminstration, `project.php` is used for the project administration, etc.

- `inc/auth.php`

  Authentication class.

- `inc/functions.php`

  Supporting functions such as `build_select()`, etc.

- `inc/db/*.php`

  These files, named by database type, contain queries (such as left joins) that have different syntaxes among various database types.

- `languages/*.php`

  Named by language code, these files contain the localization of the text used throughout phpBugTracker.

Prev | Home | Next
Configuration Options |  | Development Standards