Changes between Version 4 and Version 5 of BossaImplementation

Timestamp:

Oct 18, 2007, 2:57:35 PM (17 years ago)

Author:

davea

Comment:

--

BossaImplementation

@@ -5 +5 @@
 First, [ServerIntro set up a BOINC server] and [MakeProject create a project].
 You'll need PHP 5.2 or later (for JSON functions).
-Say your project is called 'test_project', your BOINC source directory is '~/boinc',
-and your BOINC projects directory is '~/projects'.
+Say your project is called '''test_project''', your BOINC source directory is '''~/boinc''',
+and your BOINC projects directory is '''~/projects'''.
 
 Create Bossa's database tables as follows:
@@ -21 +21 @@
 }}}
 
-You can edit bossa_setup_example.php to change the application name
+bossa_setup_example.php contains:
+{{{
+$ba = new BossaApp();
+$ba->name = 'bossa_test';
+$ba->user_friendly_name = 'Simple pattern recognition';
+$ba->start_url = 'bossa_example.php';
+
+if ($ba->insert($ba)) {
+    echo "Added application '$ba->name'\n";
+} else {
+    echo "Couldn't add '$ba->name': ", mysql_error(), "\n";
+}
+}}}
+You can edit this to change the application name
 and front-end script name, if you like.
 
-== The Bossa database tables ==
+== Database tables and PHP structures ==
 
 Until Bossa has good web-based administration tools,
-you'll need to examine and modify the MySQL database directly,
-using the command-line tool 'mysql',
+you'll need to examine and modify its MySQL database directly,
+using the command-line tool 'mysql'
 or a web-based interface such as [http://www.phpmyadmin.net/ phpMyAdmin].
 
-The Bossa tables are as follows:
+The database tables are as follows:
 
-bossa_app:
+'''bossa_app''':
 || field name || type || meaning ||
 || id || integer || row ID, assigned by MySQL ||
@@ -44 +57 @@
 || info || text || information (typically encoded in JSON) such as the criteria for which users to issue jobs to ||
 
-bossa_job:
+'''bossa_job''':
 || field name || type || meaning ||
 || id || integer || row ID, assigned by MySQL ||
@@ -59 +72 @@
 || nsuccess_needed || integer || required number of successfully completed instances ||
 
-bossa_job_inst:
+'''bossa_job_inst''':
 || field name || type || meaning ||
 || id || integer || row ID, assigned by MySQL ||
@@ -68 +81 @@
 || info || text || outcome info (usually JSON-encoded) ||
 
-bossa_app_user:
+'''bossa_app_user''':
 || app_id || integer || ID of bossa_app ||
 || user_id || integer || ID of user ||
 || info || text || description of the user's skill or ranking at a given app, typically JSON-encoded ||
 
+The Bossa PHP code uses the following classes:
+
+ '''BossaApp, BossaJob, BossaJobInst'''::
+  These correspond to the above tables, and have fields corresponding to each database field.  They offer various functions to insert, look up, and modify database rows.
+ '''Bossa''':
+  Various utility functions.
+
 == Front-end scripts ==