Correct defaults generated for CURRENT_TIMESTAMP and CURRENT_DATE

phpfui · phpfui · commit 0a7dabd0545b · 2023-04-24T15:55:56.000-04:00
diff --git a/Tests/Fixtures/Record/Definition/Order.php b/Tests/Fixtures/Record/Definition/Order.php
@@ -38,27 +38,27 @@ abstract class Order extends \PHPFUI\ORM\Record
 
 	/** @var array<string, array<mixed>> */
 	protected static array $fields = [
-		// MYSQL_TYPE, PHP_TYPE, LENGTH, NULL, DEFAULT, KEY
-		'customer_id' => ['integer', 'int', 0, true, null, false, ],
-		'employee_id' => ['integer', 'int', 0, true, null, false, ],
-		'notes' => ['longtext', 'string', 4294967295, true, null, false, ],
-		'order_date' => ['datetime', 'string', 20, true, 'CURRENT_TIMESTAMP', false, ],
-		'order_id' => ['integer', 'int', 0, false, null, true, ],
-		'order_status_id' => ['integer', 'int', 0, true, 0, false, ],
-		'order_tax_status_id' => ['integer', 'int', 0, true, null, false, ],
-		'paid_date' => ['datetime', 'string', 20, true, null, false, ],
-		'payment_type' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'ship_address' => ['longtext', 'string', 4294967295, true, null, false, ],
-		'ship_city' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'ship_country_region' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'ship_name' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'ship_state_province' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'ship_zip_postal_code' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'shipped_date' => ['datetime', 'string', 20, true, null, false, ],
-		'shipper_id' => ['integer', 'int', 0, true, null, false, ],
-		'shipping_fee' => ['decimal(19,4)', 'float', 19, true, 0, false, ],
-		'tax_rate' => ['double', 'float', 0, true, 0, false, ],
-		'taxes' => ['decimal(19,4)', 'float', 19, true, 0, false, ],
+		// MYSQL_TYPE, PHP_TYPE, LENGTH, KEY, ALLOWS_NULL, DEFAULT
+		'customer_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'employee_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'notes' => ['longtext', 'string', 4294967295, false, true, 'NULL', ],
+		'order_date' => ['datetime', 'string', 20, false, false, ],
+		'order_id' => ['integer', 'int', 0, true, false, ],
+		'order_status_id' => ['integer', 'int', 0, false, true, 0, ],
+		'order_tax_status_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'paid_date' => ['datetime', 'string', 20, false, true, 'NULL', ],
+		'payment_type' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'ship_address' => ['longtext', 'string', 4294967295, false, true, 'NULL', ],
+		'ship_city' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'ship_country_region' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'ship_name' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'ship_state_province' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'ship_zip_postal_code' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'shipped_date' => ['datetime', 'string', 20, false, true, 'NULL', ],
+		'shipper_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'shipping_fee' => ['decimal(19,4)', 'float', 19, false, true, 0, ],
+		'tax_rate' => ['double', 'float', 0, false, true, 0, ],
+		'taxes' => ['decimal(19,4)', 'float', 19, false, true, 0, ],
 	];
 
 	/** @var array<string, true> */
diff --git a/Tests/Fixtures/Record/Definition/OrderDetail.php b/Tests/Fixtures/Record/Definition/OrderDetail.php
@@ -28,17 +28,17 @@ abstract class OrderDetail extends \PHPFUI\ORM\Record
 
 	/** @var array<string, array<mixed>> */
 	protected static array $fields = [
-		// MYSQL_TYPE, PHP_TYPE, LENGTH, NULL, DEFAULT, KEY
-		'date_allocated' => ['datetime', 'string', 20, true, null, false, ],
-		'discount' => ['double', 'float', 0, false, 0, false, ],
-		'inventory_transaction_id' => ['integer', 'int', 0, true, null, false, ],
-		'order_detail_id' => ['integer', 'int', 0, false, null, true, ],
-		'order_detail_status_id' => ['integer', 'int', 0, true, null, false, ],
-		'order_id' => ['integer', 'int', 0, false, null, false, ],
-		'product_id' => ['integer', 'int', 0, true, null, false, ],
-		'purchase_order_id' => ['integer', 'int', 0, true, null, false, ],
-		'quantity' => ['decimal(18,4)', 'float', 18, false, 0, false, ],
-		'unit_price' => ['decimal(19,4)', 'float', 19, true, 0, false, ],
+		// MYSQL_TYPE, PHP_TYPE, LENGTH, KEY, ALLOWS_NULL, DEFAULT
+		'date_allocated' => ['datetime', 'string', 20, false, true, 'NULL', ],
+		'discount' => ['double', 'float', 0, false, false, 0, ],
+		'inventory_transaction_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'order_detail_id' => ['integer', 'int', 0, true, false, ],
+		'order_detail_status_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'order_id' => ['integer', 'int', 0, false, false, ],
+		'product_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'purchase_order_id' => ['integer', 'int', 0, false, true, NULL, ],
+		'quantity' => ['decimal(18,4)', 'float', 18, false, false, 0, ],
+		'unit_price' => ['decimal(19,4)', 'float', 19, false, true, 0, ],
 	];
 
 	/** @var array<string, true> */
diff --git a/Tests/Fixtures/Record/Definition/Product.php b/Tests/Fixtures/Record/Definition/Product.php
@@ -26,20 +26,20 @@ abstract class Product extends \PHPFUI\ORM\Record
 
 	/** @var array<string, array<mixed>> */
 	protected static array $fields = [
-		// MYSQL_TYPE, PHP_TYPE, LENGTH, NULL, DEFAULT, KEY
-		'attachments' => ['longblob', 'string', 0, true, null, false, ],
-		'category' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'description' => ['longtext', 'string', 4294967295, true, null, false, ],
-		'discontinued' => ['integer', 'int', 0, false, 0, false, ],
-		'list_price' => ['decimal(19,4)', 'float', 19, false, 0, false, ],
-		'minimum_reorder_quantity' => ['integer', 'int', 0, true, null, false, ],
-		'product_code' => ['varchar(25)', 'string', 25, true, null, false, ],
-		'product_id' => ['integer', 'int', 0, false, null, true, ],
-		'product_name' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'quantity_per_unit' => ['varchar(50)', 'string', 50, true, null, false, ],
-		'reorder_level' => ['integer', 'int', 0, true, null, false, ],
-		'standard_cost' => ['decimal(19,4)', 'float', 19, true, 0, false, ],
-		'target_level' => ['integer', 'int', 0, true, null, false, ],
+		// MYSQL_TYPE, PHP_TYPE, LENGTH, KEY, ALLOWS_NULL, DEFAULT
+		'attachments' => ['longblob', 'string', 0, false, true, 'NULL', ],
+		'category' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'description' => ['longtext', 'string', 4294967295, false, true, 'NULL', ],
+		'discontinued' => ['integer', 'int', 0, false, false, 0, ],
+		'list_price' => ['decimal(19,4)', 'float', 19, false, false, 0, ],
+		'minimum_reorder_quantity' => ['integer', 'int', 0, false, true, NULL, ],
+		'product_code' => ['varchar(25)', 'string', 25, false, true, 'NULL', ],
+		'product_id' => ['integer', 'int', 0, true, false, ],
+		'product_name' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'quantity_per_unit' => ['varchar(50)', 'string', 50, false, true, 'NULL', ],
+		'reorder_level' => ['integer', 'int', 0, false, true, NULL, ],
+		'standard_cost' => ['decimal(19,4)', 'float', 19, false, true, 0, ],
+		'target_level' => ['integer', 'int', 0, false, true, NULL, ],
 	];
 
 	/** @var array<string, true> */
diff --git a/docs/1. Setup.md b/docs/1. Setup.md
@@ -58,7 +58,9 @@ Use the [\PHPFUI\ORM\Migrator](http://phpfui.com/?n=PHPFUI\ORM&c=Migrator) class
 ## Generating Models
 Once you have a compatible schema, or have modified a schema, you need to generate code.  Use the [\PHPFUI\ORM\Tool\Generate\CRUD](http://phpfui.com/?n=PHPFUI%5CORM%5CTool%5CGenerate&c=CRUD) class to generate all or individual models. Check out the scripts folder for an example.
 
-Once Record and Table models are generated, they will not be overwritten by the generation tools. Feel free to add methods by hand for your application needs.
+Once **Record** and **Table** models are generated, they will not be overwritten by the generation tools. Feel free to add methods by hand for your application needs.
+
+You should regenerate models when ever you update this library. Generation will only ever overwrite files in the **Definition** namespace, which should not be edited by hand.  **Record**, **Table**, and **Validation** namespaces will only be generated if the file is missing.
 
 ## Validation
 You can also generate initial validators with the [\PHPFUI\ORM\Tool\Generate\Validator](http://phpfui.com/?n=PHPFUI%5CORM%5CTool%5CGenerate&c=Validator) class. Once generated, you should modify by hand for your application.
diff --git a/docs/2. Active Record.md b/docs/2. Active Record.md
@@ -25,11 +25,17 @@ $customer->update();
 ```
 
 ### Record::__construct
-A **Record** can be constructed 4 ways:
-- **int** primary key value, will load object values if the primary key value exists
-- **string** primary key value, will load object values if the primary key value exists
-- **array** object will be initialized to these values, but not read from the database
-- **null** (default) constructs an empty object
+A **Record** constructor attempts to read the specified row from the table. It can be constructed 4 ways:
+- **int** primary key value, will load object values if the primary key value exists.
+- **string** primary key value, will load object values if the primary key value exists.
+- **array** record is attempted to be read from database using the values of the fields provided.
+- **null** (default) constructs an empty object.
+
+Both int and string parameters to the constructor are type checked. Calling the constructor with a parameter can be see as the same as, but with type checking:
+```php
+$customer = new \App\Record\Customer();
+$customer->read($value);
+```
 
 ### The basic CRUD methods:
 - **insert**() or **create**()
diff --git a/src/PHPFUI/ORM/Tool/Generate/CRUD.php b/src/PHPFUI/ORM/Tool/Generate/CRUD.php
@@ -161,13 +161,11 @@ protected function getLine(\PHPFUI\ORM\Schema\Field $field) : string
 			case 'bool':
 			case 'datetime':
 			case 'string':
-				if ('CURRENT_TIMESTAMP' == $field->defaultValue)
+				if ('CURRENT_TIMESTAMP' == $field->defaultValue || 'CURRENT_DATE' == $field->defaultValue)
 					{
-					$defaultValue = '';
-					$allowNulls = 'true';
+					$defaultValue = null;
 					}
-
-				if (\str_contains($field->defaultValue ?? '', "'"))
+				elseif (\str_contains($field->defaultValue ?? '', "'"))
 					{
 					$defaultValue = "\"{$field->defaultValue}\"";
 					}

Original file line number	Diff line number	Diff line change
`@@ -161,13 +161,11 @@ protected function getLine(\PHPFUI\ORM\Schema\Field $field) : string`
`161`	`161`	`case 'bool':`
`162`	`162`	`case 'datetime':`
`163`	`163`	`case 'string':`
`164`		`- if ('CURRENT_TIMESTAMP' == $field->defaultValue)`
	`164`	`+ if ('CURRENT_TIMESTAMP' == $field->defaultValue \|\| 'CURRENT_DATE' == $field->defaultValue)`
`165`	`165`	`{`
`166`		`- $defaultValue = '';`
`167`		`- $allowNulls = 'true';`
	`166`	`+ $defaultValue = null;`
`168`	`167`	`}`
`169`		`-`
`170`		`- if (\str_contains($field->defaultValue ?? '', "'"))`
	`168`	`+ elseif (\str_contains($field->defaultValue ?? '', "'"))`
`171`	`169`	`{`
`172`	`170`	`$defaultValue = "\"{$field->defaultValue}\"";`
`173`	`171`	`}`