source: trunk/docs/file_layout.txt @ 1

Last change on this file since 1 was 1, checked in by scdev, 19 years ago

Initial import.

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