source: trunk/docs/file_layout.txt @ 214

Last change on this file since 214 was 214, checked in by quinn, 17 years ago

Q - Final check-in before releasing trunk as version 2.1

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