From 173a93b724913d62bb9e3a0f2db5cbb3cd4bcb2d Mon Sep 17 00:00:00 2001
From: root <root@harbourwm-beta.com>
Date: Mon, 1 Dec 2025 12:30:55 +0000
Subject: [PATCH] improved documentation

---
 sys/sys.header.php     | 27 +++++++++++++++++++++++++++
 sys.php => sys/sys.php |  0
 2 files changed, 27 insertions(+)
 create mode 100755 sys/sys.header.php
 rename sys.php => sys/sys.php (100%)

diff --git a/sys/sys.header.php b/sys/sys.header.php
new file mode 100755
index 0000000..e140f77
--- /dev/null
+++ b/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) {}
diff --git a/sys.php b/sys/sys.php
similarity index 100%
rename from sys.php
rename to sys/sys.php