added getListOrganize for created new model

added method getListByID for new model,
added type of object for import method,
extends definition tor checkDBTable,
fixed typo in parameters of method existsColumn

README.md

@@ -6,8 +6,7 @@ This library extends the builtin PDO object by several useful features.
 
 For testing create database `test` with user `test` and password `test`. In database create table `test` and insert same testing data.
 
-```
+```sql
-
 CREATE TABLE `test` (
   `id` int(11) PRIMARY KEY NOT NULL AUTO_INCREMENT,
   `name` varchar(255) DEFAULT NULL,
@@ -18,7 +17,7 @@ CREATE TABLE `test` (
 
 For basic testing run this code
 
-```
+```php
 <?php
 
 require_once __DIR__.'/../src/DBmodel.php';
@@ -53,7 +52,7 @@ print_r($result);
 
 Create file `creatorModel.php` and paste bellow code
 
-```
+```php
 <?php
 
 require_once __DIR__.'/../src/DBmodel.php';
@@ -70,7 +69,7 @@ $creator->interact();
 
 now for each table run `php createModel.php` for interactive creating class for table.
 
-```
+```bash
 $ php test2.php
 New model name: Test
 Table name: test
@@ -82,7 +81,7 @@ Creating MODEL class ... MODEL class created
 
 Creator build this MODEL class file
 
-```
+```php
 <?php
 /*
 	TPsoft.org 2000-2025
@@ -155,7 +154,7 @@ class Test extends \TPsoft\DBmodel\DBmodel {
 
 Illustrative example
 
-```
+```php
 <?php
 
 require_once __DIR__.'/../src/DBmodel.php';
@@ -196,3 +195,59 @@ print_r($result);
 
 ?>
 ```
+
+## Maintenance of database schema
+
+When developing a project, a situation arises where the DB schema needs to be modified and distributed to all installations. To ease these problems, the Maintenance class was created, which contains several useful methods. These first check if the schema contains the requested change and if it doesn't, they apply a FIX. Here is a short demonstration of what we can fix automatically in the project when changing the DB schema.
+
+```php
+<?php
+
+require_once __DIR__.'/../src/DBmodel.php';
+require_once __DIR__.'/../src/Maintenance.php';
+
+$db = new \TPsoft\DBmodel\DBmodel('mysql:host=127.0.0.1;dbname=test;charset=utf8mb4', 'test', 'test');
+
+$maintenance = new \TPsoft\DBmodel\Maintenance($db);
+
+// Check if existing table, if not create it by definition
+$suc = $maintenance->checkDBTable('users', '
+	`id` int(11) NOT NULL AUTO_INCREMENT,
+	`name` varchar(255) DEFAULT NULL,
+	`email` varchar(255) DEFAULT NULL,
+	PRIMARY KEY (`id`)
+');
+echo "\nCheckDBTable: "; var_dump($suc);
+
+// Check if existing column, if not add it by definition
+$suc = $maintenance->checkDBAdd('users', 'password', 'varchar(255) DEFAULT NULL');
+echo "\nCheckDBAdd: "; var_dump($suc);
+
+// Check if existing column
+$suc = $maintenance->existsColumn('users', 'email');
+echo "\nExistsColumn: "; var_dump($suc);
+
+// Check if existing column in new name, if not rename it
+$suc = $maintenance->checkDBRename('users', 'email', 'email_new', 'varchar(255) DEFAULT NULL');
+echo "\nCheckDBRename: "; var_dump($suc);
+
+// Chceck type of column, if not matched change it
+$suc = $maintenance->checkDBRetype('users', 'email_new', 'varchar(128)', 'varchar(128) DEFAULT NULL AFTER `password`');
+echo "\nCheckDBRetype: "; var_dump($suc);
+
+// Remove column from table
+$suc = $maintenance->checkDBRemove('users', 'email_new');
+echo "\nCheckDBRemove: "; var_dump($suc);
+
+// Add index for column
+$suc = $maintenance->addKey('users', 'name');
+echo "\nAddKey: "; var_dump($suc);
+
+// Drop index by column name
+$suc = $maintenance->dropKey('users', 'name');
+echo "\nDropKey: "; var_dump($suc);
+
+echo "\nDone\n\n";
+
+?>
+```

src/Creator.php

@@ -4,20 +4,30 @@ namespace TPsoft\DBmodel;
 
 class Creator {
 
-	private $dbh;
+	private DBmodel $dbh;
+	private string $rootDir = '';
 
-	public function __construct($dbh) {
+	public function __construct(?DBmodel $dbh = null) {
-		$this->dbh = $dbh;
+		if (is_null($dbh)) {
+			if (!is_null(DBmodel::$instance)) {
+				$this->dbh = DBmodel::$instance;
+			} else {
+				throw new \Exception('DB handler is null');
+			}
+		} else {
+			$this->dbh = $dbh;
+		}
 	}
 
 	public function interact() {
 		$name = $this->readline('New model name: ');
 		$table = $this->readline('Table name: ');
 		$entity = $this->readline('Entity name: ');
+		$namespace = $this->readline('Namespace [App\Models]: ', 'App\Models');
 		if (strlen($entity) <= 0) {
 			$entity = $table;
 		}
-		$model_filepath = $this->rootDir().'/models/'.$name.'.php';
+		$model_filepath = $this->rootDir().'/Models/'.$name.'.php';
 		if ($this->readline("Create MODEL class '$model_filepath'? (y - yes, other - no) ") != 'y') {
 			echo "Creating of MODEL class is skipped\n";
 			return false;
@@ -38,11 +48,11 @@ class Creator {
 			}
 		}
 		$table_columns = $this->dbh->getTableColumns($table);
-		$suc = $this->modelSave($model_filepath, $name, $table, $entity, $table_columns['pks'], $table_columns['columns'], $table_columns['types']);
+		$suc = $this->modelSave($model_filepath, $name, $table, $entity, $table_columns['pks'], $table_columns['columns'], $table_columns['types'], $namespace);
 		echo $suc ? "MODEL class created" : 'Error: MODEL class not created';
 	}
 
-	private function modelSave($filepath, $name, $tablename, $entity, $pks, $columns, $types) {
+	private function modelSave($filepath, $name, $tablename, $entity, $pks, $columns, $types, $namespace) {
 		if (is_array($pks) && count($pks) > 1) {
 			$primary_key_name = "array('".implode("', '", $pks)."')";
 			$columns = array_merge($pks, $columns);
@@ -84,6 +94,7 @@ class Creator {
 			$data[\'changed_dt\'] = date(\'Y-m-d H:i:s\');
 		}'
 			: '';
+		$namespace_str = strlen($namespace) > 0 ? "\nnamespace $namespace;\n" : '';
 		$content = '<?'."php
 /*
 	TPsoft.org 2000-".date('Y')."
@@ -92,12 +103,12 @@ class Creator {
 	Milestones:
 	".date('Y-m-d H:i')."  Created
 */
-
+".$namespace_str."
 class ".$name." extends \TPsoft\DBmodel\DBmodel {
 
 	public $"."tables = array(
 		'".$entity."' => array(
-			'name'             => '".$entity."',
+			'name'             => '".$tablename."',
 			'primary_key_name' => ".$primary_key_name.",
 			'allow_attributes' => array(
 				".implode(",\n\t\t\t\t", $allowed_attributes)."
@@ -140,6 +151,19 @@ class ".$name." extends \TPsoft\DBmodel\DBmodel {
 			->toArray();
 	}
 
+	public function getListOrganize($"."cola_name, $"."search = array(), $"."reverse = false, $"."concat_or = false) {
+		$"."all = $"."this->getList($"."search, $"."reverse, $"."concat_or);
+		$"."ret = array();
+		if (is_array($"."all)) foreach ($"."all as $"."key => $"."row) {
+			$"."ret[$"."row[$"."cola_name]] = $"."row;
+		}
+		return $"."ret;
+	}
+
+	public function getListByID($"."search = array(), $"."reverse = false, $"."concat_or = false) {
+		return $"."this->getListOrganize($primary_key_name, $"."search, $"."reverse, $"."concat_or);
+	}
+
 	public function ".$entity_one."Combo($"."col_key, $"."col_value, $"."add_empty = false) {
 		return $"."this->search('".$entity."')
 			->toCombo($"."col_key, $"."col_value, $"."add_empty);
@@ -166,11 +190,14 @@ class ".$name." extends \TPsoft\DBmodel\DBmodel {
 		return $line;
 	}
 
-	public function rootDir() {
+	public function rootDir(?string $dir = null) {
+		if (!is_null($dir)) {
+			$this->rootDir = $dir;
+		}
+		if (strlen($this->rootDir) > 0) return $this->rootDir;
 		return dirname(dirname(__FILE__));
 	}
 
 }
 
-
 ?>

src/DBmodel.php

@@ -27,7 +27,7 @@ class DBmodel
 	public $log = null;
 	public $tables = array();
 
-	public function __construct(string $dsn = null, ?string $username = null, #[\SensitiveParameter] ?string $password = null, ?array $options = null)
+	public function __construct(?string $dsn = null, ?string $username = null, #[\SensitiveParameter] ?string $password = null, ?array $options = null)
 	{
 		if (is_null($dsn)) {
 			if (DBmodel::$instance) {
@@ -674,12 +674,12 @@ class DBmodel
 						foreach ($data[$column] as $key => $val) {
 							$prefix = $this->extractPrefix($val, $where_prefixes);
 							$n_val = str_replace($prefix, '', $val);
-							$data[$column] = $prefix . date('Y-m-d H:i:s', strtotime($n_val));
+							$data[$column] = $prefix . date('Y-m-d H:i:s', is_numeric($n_val) ? $n_val : strtotime($n_val));
 						}
 					} else {
 						$prefix = $this->extractPrefix($data[$column], $where_prefixes);
 						$n_val = str_replace($prefix, '', $data[$column]);
-						$data[$column] = $prefix . date('Y-m-d H:i:s', strtotime($n_val));
+						$data[$column] = $prefix . date('Y-m-d H:i:s', is_numeric($n_val) ? $n_val : strtotime($n_val));
 					}
 					break;
 			}
@@ -851,7 +851,7 @@ class DBmodel
 		return $this->allowNextError();
 	}
 
-	public function import($objModel)
+	public function import(DBmodel $objModel)
 	{
 		if (is_null($objModel)) return false;
 		if (

src/Maintenance.php

@@ -0,0 +1,233 @@
+<?php
+/*
+	Copyright (c) TPsoft.org 2000-2025
+	Author: Ing. Igor Mino <mino@tpsoft.org>
+	License: GNU GPL-3.0 or later
+
+	Description: Tool for automatic maintenance of database in your project.
+	Version: 1.0.0
+
+	Milestones:
+	2025-05-29 07:59  Igor - Forked from Beteha to standalone public library
+*/
+
+namespace TPsoft\DBmodel;
+
+class Maintenance
+{
+	public const ABNORMAL = 0;
+	public const OK = 1;
+	public const FIXED = 2;
+	public const FIX_FAILED = 3;
+	public const UPDATED = 4;
+	public const UPDATE_FAIL = 5;
+
+	public string $lastMessage = '';
+
+	protected DBmodel $dbh;
+
+	public function __construct(?DBmodel $dbh)
+	{
+		if (is_null($dbh)) {
+			if (!is_null(DBmodel::$instance)) {
+				$this->dbh = DBmodel::$instance;
+			} else {
+				throw new \Exception('DB handler is null');
+			}
+		} else {
+			$this->dbh = $dbh;
+		}
+	}
+
+	public function testDB($test, $test_out)
+	{
+		if (is_array($test_out)) {
+			$test_out = array_change_key_case($test_out, CASE_LOWER);
+			$row = $this->dbh->getRow($test);
+			if (!is_array($row)) return false;
+			$row = array_change_key_case($row, CASE_LOWER);
+			foreach ($test_out as $col => $val) {
+				if (strlen($row[$col]) != strlen($val)) {
+					$max_len = min(strlen($row[$col]), strlen($val));
+					if (substr(strtolower($row[$col]), 0, $max_len) != substr(strtolower($val), 0, $max_len)) {
+						return false;
+					}
+				} else {
+					if (strtolower($row[$col]) != strtolower($val)) {
+						return false;
+					}
+				}
+			}
+			return true;
+		} else {
+			return $this->dbh->getOne($test) == $test_out;
+		}
+	}
+
+	public function checkDB($test, $test_out, $fix)
+	{
+		if ($this->testDB($test, $test_out)) {
+			return Maintenance::OK;
+		} else {
+			$this->dbh->query($fix);
+			if ($this->testDB($test, $test_out)) {
+				return Maintenance::FIXED;
+			} else {
+				return Maintenance::FIX_FAILED;
+			}
+		}
+		return 0;
+	}
+
+	public function existsTable($table_name)
+	{
+		return $this->testDB(
+			'SHOW TABLES LIKE "' . $table_name . '"',
+			$table_name
+		);
+	}
+
+	public function checkDBTable($table_name, $definition, $after_definition = '')
+	{
+		if (strlen($table_name) <= 0) {
+			$this->lastMessage = 'Table ' . strtoupper($table_name) . ' - invalid index';
+			return Maintenance::ABNORMAL;
+		}
+		$status = $this->checkDB(
+			// TEST query
+			'SHOW TABLES LIKE "' . $table_name . '"',
+			// TEST output
+			$table_name,
+			// FIX query
+			'CREATE TABLE `' . $table_name . '` (' . $definition . ') ' . $after_definition
+		);
+		$this->lastMessage = 'Table ' . strtoupper($table_name) . ' (' . $table_name . ')';
+		return $status;
+	}
+
+	public function existsColumn($table_name, $column)
+	{
+		return $this->testDB(
+			'DESCRIBE `' . $table_name . '` `' . $column . '`',
+			$column
+		);
+	}
+
+	public function checkDBAdd($table_name, $column, $definition)
+	{
+		$status = $this->checkDB(
+			// TEST query
+			'DESCRIBE `' . $table_name . '` `' . $column . '`',
+			// TEST output
+			$column,
+			// FIX query
+			'ALTER TABLE `' . $table_name . '` ADD `' . $column . '` ' . $definition
+		);
+		$this->lastMessage = "Added column $column to table $table_name";
+		return $status;
+	}
+
+	public function checkDBRename($table_name, $column_old, $column_new, $definition, $test = null)
+	{
+		if (!$this->existsColumn($table_name, $column_old)) {
+			return Maintenance::ABNORMAL;
+		}
+		$status = $this->checkDB(
+			// TEST query
+			'DESCRIBE `' . $table_name . '` `' . $column_old . '`',
+			// TEST output
+			$test,
+			// FIX query
+			'ALTER TABLE `' . $table_name . '` CHANGE `' . $column_old . '` `' . $column_new . '` ' . $definition
+		);
+		$this->lastMessage = "Renamed  column $column_old to $column_new for $table_name";
+		return $status;
+	}
+
+	public function checkDBRetype($table_name, $column, $new_type, $definition)
+	{
+		if (!$this->existsColumn($table_name, $column)) {
+			return Maintenance::ABNORMAL;
+		}
+		$status = $this->checkDB(
+			// TEST query
+			'DESCRIBE `' . $table_name . '` `' . $column . '`',
+			// TEST output
+			array('type' => strtolower($new_type)),
+			// FIX query
+			'ALTER TABLE `' . $table_name . '` CHANGE `' . $column . '` `' . $column . '` ' . $definition
+		);
+		$this->lastMessage = "Changed type of column $column for table " . strtoupper($table_name) . " to tyoe " . strtoupper($new_type);
+		return $status;
+	}
+
+	public function checkDBRemove($table_name, $column)
+	{
+		$status = $this->checkDB(
+			// TEST query
+			'DESCRIBE `' . $table_name . '` `' . $column . '`',
+			// TEST output
+			NULL,
+			// FIX query
+			'ALTER TABLE `' . $table_name . '` DROP COLUMN `' . $column . '`'
+		);
+		$this->lastMessage = "Removed column $column for " . strtoupper($table_name);
+		return $status;
+	}
+
+	public function addKey($table_name, $key)
+	{
+		$test = 'SHOW INDEX FROM `' . $table_name . '` WHERE column_name = "' . $key . '"';
+		$test_out = array('table' => $table_name);
+		if ($this->testDB($test, $test_out)) {
+			$status = Maintenance::OK;
+		} else {
+			$fix = 'CREATE INDEX `' . $key . '` ON `' . $table_name . '` (`' . $key . '`)';
+			$this->dbh->query($fix);
+			if ($this->testDB($test, $test_out)) {
+				$status = Maintenance::FIXED;
+			} else {
+				$status = Maintenance::FIX_FAILED;
+			}
+		}
+		$this->lastMessage = 'Added KEY ' . $key . ' for ' . strtoupper($table_name);
+		return $status;
+	}
+
+	public function dropKey($table_name, $key)
+	{
+		$test = 'SHOW INDEX FROM `' . $table_name . '` WHERE column_name = "' . $key . '"';
+		$test_out = null;
+		if ($this->testDB($test, $test_out)) {
+			$status = Maintenance::OK;
+		} else {
+			$index_info = $this->dbh->getRow('SHOW INDEX FROM `' . $table_name . '` WHERE column_name = "' . $key . '"');
+			$index_info = array_change_key_case($index_info, CASE_LOWER);
+			$index_name = $index_info['key_name'];
+			$fix = 'ALTER TABLE `' . $table_name . '` DROP INDEX `' . $index_name . '`';
+			$this->dbh->query($fix);
+			if ($this->testDB($test, $test_out)) {
+				$status = Maintenance::FIXED;
+			} else {
+				$status = Maintenance::FIX_FAILED;
+			}
+		}
+		$this->lastMessage = 'Deleted KEY ' . $key . ' for ' . strtoupper($table_name);
+		return $status;
+	}
+
+	public function updateDB($test, $test_out, $update)
+	{
+		if (!$this->testDB($test, $test_out)) {
+			return Maintenance::OK;
+		} else {
+			$suc = $this->dbh->query($update);
+			if ($suc !== false) {
+				return Maintenance::UPDATED;
+			} else {
+				return Maintenance::UPDATE_FAIL;
+			}
+		}
+		return 0;
+	}
+}

test/test2.php

@@ -1,7 +1,7 @@
 <?php
 
 require_once __DIR__.'/../src/DBmodel.php';
-require_once __DIR__.'/../src/creator.php';
+require_once __DIR__.'/../src/Creator.php';
 
 $db = new \TPsoft\DBmodel\DBmodel('mysql:host=127.0.0.1;dbname=test;charset=utf8mb4', 'test', 'test');
 

test/test4.php

@@ -0,0 +1,49 @@
+<?php
+
+require_once __DIR__.'/../src/DBmodel.php';
+require_once __DIR__.'/../src/Maintenance.php';
+
+$db = new \TPsoft\DBmodel\DBmodel('mysql:host=127.0.0.1;dbname=test;charset=utf8mb4', 'test', 'test');
+
+$maintenance = new \TPsoft\DBmodel\Maintenance($db);
+
+// Check if existing table, if not create it by definition
+$suc = $maintenance->checkDBTable('users', '
+	`id` int(11) NOT NULL AUTO_INCREMENT,
+	`name` varchar(255) DEFAULT NULL,
+	`email` varchar(255) DEFAULT NULL,
+	PRIMARY KEY (`id`)
+');
+echo "\nCheckDBTable: "; var_dump($suc);
+
+// Check if existing column, if not add it by definition
+$suc = $maintenance->checkDBAdd('users', 'password', 'varchar(255) DEFAULT NULL');
+echo "\nCheckDBAdd: "; var_dump($suc);
+
+// Check if existing column
+$suc = $maintenance->existsColumn('users', 'email');
+echo "\nExistsColumn: "; var_dump($suc);
+
+// Check if existing column in new name, if not rename it
+$suc = $maintenance->checkDBRename('users', 'email', 'email_new', 'varchar(255) DEFAULT NULL');
+echo "\nCheckDBRename: "; var_dump($suc);
+
+// Chceck type of column, if not matched change it
+$suc = $maintenance->checkDBRetype('users', 'email_new', 'varchar(128)', 'varchar(128) DEFAULT NULL AFTER `password`');
+echo "\nCheckDBRetype: "; var_dump($suc);
+
+// Remove column from table
+$suc = $maintenance->checkDBRemove('users', 'email_new');
+echo "\nCheckDBRemove: "; var_dump($suc);
+
+// Add index for column
+$suc = $maintenance->addKey('users', 'name');
+echo "\nAddKey: "; var_dump($suc);
+
+// Drop index by column name
+$suc = $maintenance->dropKey('users', 'name');
+echo "\nDropKey: "; var_dump($suc);
+
+echo "\nDone\n\n";
+
+?>