2. Guidelines

2.1 Requirements

These guidelines must be followed for any application that wants considered for inclusion into phpGroupWare deluxe.

It must run on PHP3 and PHP4.
SQL statements must be compatible with both MySQL and PostgreSQL.
It must use our default header.inc.php include.
It must use our $phpgw_link($url) for all links (this is for session support).
It must use "post" for forms.
It must respect phpGW group rights and phpGW user permissions.
It must use our directory structure, template support and lang (multi-language) support.
Where possible it should run on both Unix and NT platforms.

For applications that do not meet these requirements, they can be available to users via the phpGroupWare Apps project, or whatever means the developers decide.
If you need help converting your application to templates and our lang support, we will try to connect you with someone to help.

2.2 Writing/porting your application

Include files

Each PHP page you write will need to include the header.inc.php along with a few variables.
This is done by putting this at the top of each PHP page.

  <?php
  $phpgw_info["flags"]["currentapp"] = "appname";
  include("../header.inc.php");
  ?>

• The phpgwAPI - The phpGroupWare API will be loaded.
• The phpGW navbar will be loaded (by default, but can be disabled until a later point.
• appname/inc/functions.inc.php - This file is loaded just after the phpgwAPI and before any HTML code is generated. This file should include all your application specific functions.. You are welcome to include any additional files you need from within this file.
• appname/inc/header.inc.php - This file is loaded just after the system header/navbar, and allows developers to use it for whatever they need to load.
• appname/inc/footer.inc.php - This file is loaded just before the system footer, allowing developers to close connections and whatever else they need.
• The phpGW footer will be loaded, which closes several connections.