| 1 | -------------------------------------------------------------------------------- |
|---|
| 2 | Strangecode codebase 2.0 |
|---|
| 3 | -------------------------------------------------------------------------------- |
|---|
| 4 | |
|---|
| 5 | Codebase self contained. runs without reference to external files or info. |
|---|
| 6 | - can be located in /usr/local/php/lib/php for server-wide access |
|---|
| 7 | - does not include any files outside codebase |
|---|
| 8 | - does not write to files outside codebase |
|---|
| 9 | - does not try to determine it's location or site parameters. this will minimize it's failure to glean this info. |
|---|
| 10 | - will still run if info missing: db creds, log dir, session info. |
|---|
| 11 | - can be located in /usr/local/lib/php if necessary, so accessible by all sites. |
|---|
| 12 | |
|---|
| 13 | remove interdependencies: |
|---|
| 14 | - App() is the only dependency for other classes. It includes Utilities.inc.php silently. |
|---|
| 15 | - Update libs requiring external files, such as html templates and email templates, classes now self-contained. |
|---|
| 16 | |
|---|
| 17 | Things with modified interfaces: |
|---|
| 18 | - App |
|---|
| 19 | - Auth_SQL |
|---|
| 20 | - DB |
|---|
| 21 | - DBSessionHandler |
|---|
| 22 | - RecordLock |
|---|
| 23 | - RecordVersion |
|---|
| 24 | - SessionCache |
|---|
| 25 | |
|---|
| 26 | One application will always have distinct: |
|---|
| 27 | - Configurations: |
|---|
| 28 | - log dir |
|---|
| 29 | - log config |
|---|
| 30 | - debugging |
|---|
| 31 | - charset |
|---|
| 32 | - session data |
|---|
| 33 | - Objects: |
|---|
| 34 | - auth |
|---|
| 35 | - db |
|---|
| 36 | - Environment: |
|---|
| 37 | - seperate codebase installs if necessary for each app |
|---|
| 38 | - unique include path |
|---|
| 39 | - site/doc/web root |
|---|
| 40 | - lang |
|---|
| 41 | - $dbh database handler |
|---|
| 42 | |
|---|
| 43 | App object: |
|---|
| 44 | - object belongs to a realm, keeping messages and session data within specific site/app. |
|---|
| 45 | - uses the singleton pattern so only one instance of App exists for each app. |
|---|
| 46 | - app object can be accessed globally without reference to object name by calling methods statically, e.g. App:logMsg() |
|---|
| 47 | - seperate application and codebase parameters from site configuration variables. |
|---|
| 48 | Use $app->getParam('var') or App::getParam('var') to get app params. |
|---|
| 49 | F or site configurations do whatever you want (I'm using $cfg['node']['features'] format for configurations) |
|---|
| 50 | |
|---|
| 51 | App configuration parameters |
|---|
| 52 | - defaults part of the app class |
|---|
| 53 | - do not need to be set in any specific order |
|---|
| 54 | - missing vars are dynamically accounted for. |
|---|
| 55 | |
|---|
| 56 | DB object: |
|---|
| 57 | - Self contained class for DB functions. db::query is the only necessary function. Maintains connections and state independent of App. |
|---|
| 58 | |
|---|
| 59 | Full test suite for all codebase libraries. Run from the command line: "codebase/tests/run_tests.sh;" |
|---|
| 60 | |
|---|
| 61 | Classes that access database tables have a function initDB() that will setup the basic schema necessary to run. This includes Auth_SQL, RecordVersion, RecordLock, and DBSessionHandler. |
|---|
| 62 | |
|---|
| 63 | And much much more still to document... |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | -------------------------------------------------------------------------------- |
|---|
| 68 | Strangecode codebase 1.0.0 release |
|---|
| 69 | -------------------------------------------------------------------------------- |
|---|
| 70 | |
|---|
| 71 | This is the primary stable release used before we started using Subversion. It was maintained erratically by one erratic person. No revision info documented, sorry. |
|---|
| 72 | |
|---|
| 73 | |
|---|
