| 1 | Updated: 11 Dec 2006 16:25:10 |
|---|
| 2 | (This document is probably out-of-date.) |
|---|
| 3 | ===================================================================== |
|---|
| 4 | |
|---|
| 5 | codebase/ |
|---|
| 6 | bin/ (generic command-line scripts and applications) |
|---|
| 7 | acl.cli.php (Tool for managing the permissions of an ACL.inc.php based system) |
|---|
| 8 | extract_gettext.pl (tool for exporting all the strings called by the _("Gettext function") ) |
|---|
| 9 | file_importer.php |
|---|
| 10 | install.sh |
|---|
| 11 | module_maker/ (scripts for generating modules) |
|---|
| 12 | _config.inc.php |
|---|
| 13 | form_template.cli.php |
|---|
| 14 | list_template.cli.php |
|---|
| 15 | module.cli.php |
|---|
| 16 | skel/ (templates for generating modules) |
|---|
| 17 | adm_form.ihtml |
|---|
| 18 | adm_list.ihtml |
|---|
| 19 | admin.php |
|---|
| 20 | public_list.ihtml |
|---|
| 21 | public.ihtml |
|---|
| 22 | public.php |
|---|
| 23 | sql.cli.php |
|---|
| 24 | validation.cli.php |
|---|
| 25 | pedit_permissions.sh |
|---|
| 26 | css/ (generic CSS files to be included using lib/CSS.inc.php) |
|---|
| 27 | admin.inc.css (CSS for the generic Strangecode administration system) |
|---|
| 28 | codebase.inc.css (CSS for html output by codebase libraries) |
|---|
| 29 | utilities.inc.css (generic CSS tools) |
|---|
| 30 | docs/ |
|---|
| 31 | coding_standards.txt |
|---|
| 32 | example_config.inc.php (an example of the _config.inc.php site-boot document) |
|---|
| 33 | example_script_template.php |
|---|
| 34 | example_virtualhost_directive.txt |
|---|
| 35 | file_layout.txt |
|---|
| 36 | gpl.txt |
|---|
| 37 | revision_history.txt |
|---|
| 38 | version.txt (the version number of this codebase) |
|---|
| 39 | lib/ |
|---|
| 40 | ACL.inc.php (provides Access Control List functionality) |
|---|
| 41 | App.inc.php (provides global application functionality: sessions, href/url/IP manipulation, directories) |
|---|
| 42 | Auth_File.inc.php (file-based authentication system) |
|---|
| 43 | Auth_SQL.inc.php (sql-based authentication system) |
|---|
| 44 | AuthorizeNet.inc.php (routines for connection to authorize.net's advanced processing interface) |
|---|
| 45 | Cache.inc.php (provides session-based caching functionality for quick retrieval of all PHP data types) |
|---|
| 46 | CSS.inc.php (manage and deliver CSS data) |
|---|
| 47 | DB.inc.php (minimal database abstraction layer) |
|---|
| 48 | DBSessionHandler.inc.php (database session handler) |
|---|
| 49 | Email.inc.php (provides email validation and sending functionality) |
|---|
| 50 | FormValidator.inc.php (validation routines used to test incoming user data) |
|---|
| 51 | Google_API.inc.php (class for connecting to, querying, and dealing with data of the Google API) |
|---|
| 52 | Heirarchy.php (class for manipulation of hierarchies) |
|---|
| 53 | Image.inc.php (manage printing of images related to db records) |
|---|
| 54 | ImageThumb.inc.php (automated image thumbnailing routines) |
|---|
| 55 | Lock.inc.php (db record locking system) |
|---|
| 56 | MCVE.inc.php |
|---|
| 57 | Navigation.inc.php (navigation element management class)) |
|---|
| 58 | PageNumbers.inc.php (class for managing and printing various elements of page numbers and pagination) |
|---|
| 59 | PageSequence.inc.php (manage a sequence of steps and data from step form elements, like order checkout or signup) |
|---|
| 60 | PayPal.inc.php |
|---|
| 61 | PEdit.inc.php (page-by-page file-based content management system) |
|---|
| 62 | Prefs.inc.php (class for semi-permanent storage of values) |
|---|
| 63 | ScriptTimer.inc.php (timer for scripts) |
|---|
| 64 | SortOrder.inc.php (class dealing with sorting of columns in database generated lists) |
|---|
| 65 | SpellCheck.inc.php |
|---|
| 66 | TemplateGlue.inc.php (functions that generating html) |
|---|
| 67 | Upload.inc.php (class that manages uploading of files) |
|---|
| 68 | Utilities.inc.php (functions for general utility: setting defaults, num/string functions, etc) |
|---|
| 69 | Version.inc.php (db record versioning system) |
|---|
| 70 | services/ (codebase scripts that are only useful when web accessible, i.e. to be used in a doc root) |
|---|
| 71 | admins.php |
|---|
| 72 | css.php |
|---|
| 73 | lock.php |
|---|
| 74 | login.php |
|---|
| 75 | logout.php |
|---|
| 76 | logs.php |
|---|
| 77 | password.php |
|---|
| 78 | phpinfo.php |
|---|
| 79 | provides |
|---|
| 80 | templates/ |
|---|
| 81 | versions.php |
|---|
| 82 | tests/ (unit-based tests for all codebase libraries) |
|---|
| 83 | |
|---|
| 84 | =================================================================================== |
|---|
| 85 | Group of applications and related files, usually installed at /home/user/www.domain.com/ |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | global/ (global level configuration and libraries for a group of sites/apps) |
|---|
| 89 | config.inc.php (system-wide configuration) |
|---|
| 90 | db_auth.inc.php (db-authentication for CLI scripts. chown'ed by user executing cron, NOT apache). |
|---|
| 91 | |
|---|
| 92 | docs/ (documents specific to a group of sites/apps) |
|---|
| 93 | schema.mysql |
|---|
| 94 | |
|---|
| 95 | bin/ (global level command-line scripts) |
|---|
| 96 | |
|---|
| 97 | admin/ (DocumentRoot for the admin application) |
|---|
| 98 | _config.inc.php |
|---|
| 99 | _templates/ (templates used for the admin docroot) |
|---|
| 100 | _widgets/ (graphic elements used by the admin docroot) |
|---|
| 101 | admins.php (list, view, edit, delete administrators) |
|---|
| 102 | css.php (style sheets loader) |
|---|
| 103 | index.php |
|---|
| 104 | lock.php (manage locked db records) |
|---|
| 105 | login.php (login to the admin system) |
|---|
| 106 | logout.php (accessing logs-out an admin) |
|---|
| 107 | logs.php (view logs) |
|---|
| 108 | password.php (change password of currently logged-in admin) |
|---|
| 109 | phpinfo.php |
|---|
| 110 | versions.php (manage db record versions) |
|---|
| 111 | |
|---|
| 112 | html/ (DocumentRoot of main site application) |
|---|
| 113 | _config.inc.php (configuration options and defaults specific to this site. included first in each script) |
|---|
| 114 | _templates/ (site specific templates. templates here override global codebase templates with same name) |
|---|
| 115 | css.php (style sheets loader) |
|---|
