Code Overview

Directory Structure

The files that make up SeltzerCRM are organized as follows: / - root directory, license, readme, etc. crm/ - The root path of the web app and front end php files include/ - The php files that make up the web app config.inc.php - The configuration file crm.inc.php - A central include that includes the rest of the web app core/ - The core module code sys/ - Core subsystems to be used by all modules member/ - The member module code key/ - The key module code doc/ - The doxygen-generated documentation

Layers

The SeltzerCRM code is organized into several layers of abstraction. These layers represent the flow of information from the database to the user's screen. From top to bottom, the layers are:

1. Theme Layer (HTML generation)
2. Structure Layer (Tables, Forms, etc.)
3. Data Layer (Database communication)

The Theme layer produces themed HTML from the structure layer. Functions in this layer start with the "theme_" prefix and take Structure layer objects as input.

The Structure layer produces tree data structures that represent display elements (tables, forms, etc.) These functions end with the "_table" or "_form" suffix. These functions usually take Data layer objects as input.

The Data layer produces tree data structures that represent abstract entities (contacts, users, etc.) These functions end in the "_data" suffix and communicate with the database via SQL.

Subsystems

The SeltzerCRM core code also provides utilities that are likely to be useful to developers. They are represented by the following subsystems:

• Permissions System
• Command System
• Module System
• Error Reporting System