improved documentation

sys/sys.header.php

@@ -0,0 +1,27 @@
+<?php
+/* 
+*   
+*     3. SYS-Level 
+*     
+*     A PURELY DOCUMENTATION FILE.  
+*/
+function sql_read($query) {}
+function sql_write($query) {}
+function sql($query) {}
+
+function runProcess($cmd, $stdin, &$stdout, &$stderr) {}
+function getTblPrimaryKeyColName($tblName) {}
+
+/**
+ * Executes a SELECT query and hydrates any foreign key columns with the
+ * referenced row data.
+ *
+ * The query should target a single table (e.g., "SELECT * FROM db.table WHERE …").
+ * For each foreign key in that table, an additional key named
+ * `<column>_ref` is added to each returned row containing the referenced row
+ * from the foreign table.
+ *
+ * @param string $query SQL SELECT statement for a single table.
+ * @return array        Result set with hydrated foreign key data.
+ */
+function sql_read_and_hydrate($query) {}