Releasing 1.1.0

Author: technicalguru

README.md

@@ -270,7 +270,7 @@ As above mentioned, you can use your own data classes. There are actually no
 restrictions other than the class needs a no-argument constructor. The main
 advantage is that this class can have additional methods that have some
 logic. You can even define additional attributes that will not be saved in
-the database by a DAO. These attributes start with an underscore (_).
+the database by a DAO. These attributes start with an underscore.
 
 Here is an example:
 

composer.json

@@ -23,7 +23,12 @@
 			"TgDatabase\\" : "src/TgDatabase/"
 		}
 	},
+	"extra": {
+		"branch-alias": {
+			"dev-master": "1.0-dev"
+		}
+	},
 	"require-dev" : {
 		"phpunit/phpunit" : "^9"
 	}
-}
+}

src/TgDatabase/DAO.php

@@ -24,15 +24,60 @@ class DAO {
 	/**
 	 * Constructor.
 	 * @param Database $database - the database object
-	 * @param string $tableName  - the table name this object will handle (can include #__ as prefix)
-	 * @param string $modelClass - the name of the class that rows will be converted to (optional, default is \stdClass).
-	 * @param string $idColumn   - the name of the integer, auto-incremental primary key column (optional, default is uid)
+	 * @param string  $tableName  - the table name this object will handle (can include #__ as prefix)
+	 * @param string  $modelClass - the name of the class that rows will be converted to (optional, default is \stdClass).
+	 * @param string  $idColumn   - the name of the integer, auto-incremental primary key column (optional, default is uid)
+	 * @param boolean $checkTable - whether to check existance of table and create if required (optional, default is FALSE)
 	 */
-	public function __construct($database, $tableName, $modelClass = 'stdClass', $idColumn = 'uid') {
+	public function __construct($database, $tableName, $modelClass = 'stdClass', $idColumn = 'uid', $checkTable = FALSE) {
 		$this->database   = $database;
 		$this->tableName  = $tableName;
 		$this->modelClass = class_exists($modelClass) ? $modelClass : 'stdClass';
 		$this->idColumn   = $idColumn;
+		if ($checkTable) $this->checkTable();
+	}
+
+	/**
+	 * Checks the underlying table for existance and calls #createTable() if it does not exist.
+	 * @return boolean TRUE when table exists or was created successfully.
+	 */
+	public function checkTable() {
+		if (!$this->tableExists()) {
+			return $this->createTable();
+		}
+		return TRUE;
+	}
+
+	/**
+	 * Creates the table. Default implementation does nothing and returns FALSE.
+	 * @return TRUE when table was created successfully.
+	 */
+	public function createTable() {
+		return FALSE;
+	}
+
+	/**
+	 * Checks existance of the underlying table.
+	 * @return string TRUE when table exists, FALSE otherwise.
+	 */
+	public function tableExists() {
+		return $this->database->tableExists($this->tableName);
+	}
+
+	/**
+	 * Describes the underlying table.
+	 * {
+     *   "Field":   "uid",
+     *   "Type":    "int(10) unsigned",
+     *   "Null":    "NO",
+     *   "Key":     "PRI",
+     *   "Default": null,
+     *   "Extra":   "auto_increment"
+     * }
+	 * @return array of columns (empty when error occured).
+	 */
+	public function describeTable() {
+		return $this->database->describeTable($this->tableName);
 	}
 
 	/** 

src/TgDatabase/DataModel.php

@@ -57,5 +57,27 @@ public function getDatabase() {
     public function register($name, $dao) {
         $this->models[$name] = $dao;
     }
+
+	/**
+	 * Performs a check of each DAO whether underlying tables exists and creates them if required.
+	 * @return object with the result(s):
+	 * {
+	 *   "tableChecks" : {
+	 *      "<dao-registered-name>" : TRUE|FALSE,
+	 *      ...
+	 *   },
+	 *   "success" : TRUE|FALSE
+	 * }
+	 */
+	public function checkTables() {
+		$rc = new \stdClass;
+		$rc->tableChecks = new \stdClass;
+		$rc->success     = TRUE;
+		foreach ($this->models AS $name => $dao) {
+			$rc->tableChecks->$name = $dao->checkTable();
+			if (!$rc->tableChecks->$name) $rc->success = FALSE;
+		}
+		return $rc;
+	}
 }
 

src/TgDatabase/Database.php

@@ -94,6 +94,39 @@ public function quoteName($s) {
 		return '`'.$s.'`';
 	}
 
+	/**
+	 * Checks existance of a table.
+	 * @param string $tableName - name of table to be checked
+	 * @return string TRUE when table exists, FALSE otherwise.
+	 */
+	public function tableExists($tableName) {
+		$res = $this->query('SELECT * FROM '.$tableName);
+		$rc  = $res !== FALSE;
+		if ($res) $res->free();
+		return $rc;
+	}
+
+	/**
+	 * Describes a table.
+	 * {
+     *   "Field":   "uid",
+     *   "Type":    "int(10) unsigned",
+     *   "Null":    "NO",
+     *   "Key":     "PRI",
+     *   "Default": null,
+     *   "Extra":   "auto_increment"
+     * }
+	 * @param string $tableName - name of table to be described
+	 * @return array of columns (empty when error occured).
+	 */
+	public function describeTable($tableName) {
+		$rc = array();
+		foreach ($this->queryList('DESCRIBE '.$tableName) AS $field) {
+			$rc[$field->Field] = $field;
+		}
+		return $rc;
+	}
+
 	/**
 	 * Execute the given SQL.
 	 * <p>This can be any arbitrary SQL statement. The function will only replace the table prefix

test.sh

@@ -0,0 +1,7 @@
+# Test script
+
+composer update
+RC=./vendor/phpunit/phpunit/phpunit tests
+rm -rf vendor composer.lock
+exit $RC
+