Changeset 136 for trunk/docs

Timestamp:

Jun 3, 2006 7:47:48 PM (18 years ago)

Author:

scdev

Message:

Q - Merged branches/2.0singleton into trunk. Completed updating classes to use singleton methods. Implemented tests. Fixed some bugs. Changed some interfaces.

Location:

trunk/docs

Files:

• coding_standards.txt (modified) (2 diffs)
• example_config.inc.php (modified) (1 diff)
• example_script_template.php (modified) (1 diff)
• file_layout.txt (modified) (1 diff)
• revision_history.txt (modified) (3 diffs)
• version.txt (added)

trunk/docs/coding_standards.txt

@@ -183 +183 @@
         ?>
         <div align="right" class="sc-tiny">
-        [&nbsp;<a href="<?php echo App::oHREF('contact.php') ?>">Contact us</a>&nbsp;]
+        [&nbsp;<a href="<?php echo $app->oHREF('contact.php') ?>">Contact us</a>&nbsp;]
         </div>
         <?php
@@ -214 +214 @@
     function getSetEnumFieldValues()
     {
-        $qid = DB::query("SHOW COLUMNS FROM $db_table LIKE '$db_col'",false);
+        $db =& DB::getInstance();
+        
+        $qid = $db->query("SHOW COLUMNS FROM $db_table LIKE '$db_col'",false);
 
         $row = mysql_fetch_row($qid);

trunk/docs/example_config.inc.php

@@ -70 +70 @@
 // DB credentials for command line scripts stored in a file with read rights
 // given only to the user who will be executing the scripts: -rw-------
-// This file includes App:: method calls so must be included after App.
+// This file includes $app-> method calls so must be included after App.
 require_once 'global/db_auth.inc.php';
 
+// Start application-based functionality: database, session, environment, ini setup, etc.
 // Most configuration parameters must be set before starting the App.
 $app->start();
+
+// Global DB object. Automatically preconfigured by $app->start().
+$db =& DB::getInstance();
 
 // User authentication.

trunk/docs/example_script_template.php

@@ -11 +11 @@
 
 $auth->requireLogin();
-App::sslOn();
+$app->sslOn();
 
 require_once 'codebase/lib/FormValidator.inc.php';

trunk/docs/file_layout.txt

@@ -55 +55 @@
         RecordVersion.inc.php (db record versioning system)
         ScriptTimer.inc.php (timer for scripts)
-        SessionCache.inc.php (class for accessing a cache in a users session, stores any variables for quick retreival)
+        Cache.inc.php (class for accessing a cache in a users session, stores any variables for quick retreival)
         SortOrder.inc.php (class dealing with sorting of columns in database generated lists)
         SpellCheck.inc.php

trunk/docs/revision_history.txt

@@ -31 +31 @@
     - RecordLock
     - RecordVersion
-    - SessionCache
+    - Cache
     - Upload
 
@@ -56 +56 @@
     - app object can be accessed globally without reference to object name by calling methods statically, e.g. App:logMsg()
     - seperate application and codebase parameters from site configuration variables.
-      Use $app->getParam('var') or App::getParam('var') to get app params.
+      Use $app->getParam('var') or $app->getParam('var') to get app params.
       F or site configurations do whatever you want (I'm using $cfg['node']['features'] format for configurations)
 
@@ -68 +68 @@
 
 DB object:
-    - Self contained class for DB functions. db::query is the only necessary function. Maintains connections and state independent of App.
+    - Self contained class for DB functions. $db->query is the only necessary function. Maintains connections and state independent of App.
 
 Full test suite for all codebase libraries. Run from the command line: "codebase/tests/run_tests.sh;"