Delete Children on delete

Author: phpfui

Tests/Fixtures/Record/Order.php

@@ -5,7 +5,7 @@
 class Order extends \Tests\Fixtures\Record\Definition\Order
 	{
 	protected static array $virtualFields = [
-		'OrderDetailChildren' => [\PHPFUI\ORM\Children::class, \Tests\Fixtures\Table\OrderDetail::class, 'order_detail_id'],
+		'orderDetailChildren' => [\PHPFUI\ORM\Children::class, \Tests\Fixtures\Table\OrderDetail::class, 'order_detail_id'],
 		'order_date' => [\PHPFUI\ORM\Cast::class, \Carbon\Carbon::class],
 		'paid_date' => [\PHPFUI\ORM\Cast::class, \Carbon\Carbon::class],
 		'shipped_date' => [\PHPFUI\ORM\Cast::class, \Carbon\Carbon::class],

Tests/Unit/ChildrenTest.php

@@ -8,7 +8,7 @@ public function testChildren() : void
 		{
 		$order = new \Tests\Fixtures\Record\Order(44);
 		$this->assertTrue($order->loaded());
-		$orderDetails = $order->OrderDetailChildren;
+		$orderDetails = $order->orderDetailChildren;
 		$this->assertCount(3, $orderDetails);
 		$this->assertEquals(25.0 * 18.0, $orderDetails->current()->gross);
 		}

Tests/Unit/DeleteTest.php

@@ -17,6 +17,20 @@ public function testRecordDelete() : void
 		$this->assertEquals(29, $table->count());
 		}
 
+	public function testDeleteChildren() : void
+		{
+		$order = new \Tests\Fixtures\Record\Order(31);
+		$this->assertCount(3, $order->orderDetailChildren);
+		$transaction = new \PHPFUI\ORM\Transaction();
+		$orderDetailTable = new \Tests\Fixtures\Table\OrderDetail();
+		$orderDetailTable->setWhere(new \PHPFUI\ORM\Condition('order_id', 31));
+		$this->assertCount(3, $orderDetailTable);
+		$order->delete();
+		$this->assertCount(0, $orderDetailTable);
+		$this->assertTrue($transaction->rollBack());
+		$this->assertCount(3, $orderDetailTable);
+		}
+
 	public function testTableDelete() : void
 		{
 		$table = new \Tests\App\Table\Customer();

docs/5. Virtual Fields.md

@@ -83,15 +83,17 @@ class Order extends \Tests\App\Record\Definition\Order
   {
   protected static array $virtualFields = [
     // the OrderDetailChildren will be returned in order_detail_id order. Leave off the third array element to let SQL determine the order if you don't care.
-    'OrderDetailChildren' => [\PHPFUI\ORM\Children::class, \Tests\App\Table\OrderDetail::class, 'order_detail_id'],
+    'orderDetailChildren' => [\PHPFUI\ORM\Children::class, \Tests\App\Table\OrderDetail::class, 'order_detail_id'],
   ];
   }
 ```
 
+By default, child records will be automatically deleted when the parent record is deleted. You can disable this functionality for a specific record class by setting the static property $deleteChildren to false, or using your own Children class.
+
 ### Usage
 ```php
 $order = new \App\Record\Order(31);
-foreach ($order->OrderDetailChildren as $orderDetail)
+foreach ($order->orderDetailChildren as $orderDetail)
   {
   echo "Gross {$orderDetail->gross} for product {$orderDetail->product->product_name}\n";
   }

src/PHPFUI/ORM/Children.php

@@ -12,27 +12,23 @@
  * Example:
  * ```php
  * protected static array $virtualFields = [
- *   'OrderDetailChildren' => [\PHPFUI\ORM\Children::class, \Tests\App\Table\OrderDetail::class, 'data_allocated', 'desc'],
+ *   'orderDetailChildren' => [\PHPFUI\ORM\Children::class, \Tests\App\Table\OrderDetail::class, 'data_allocated', 'desc'],
  * ];
  * ```
  */
 class Children extends \PHPFUI\ORM\VirtualField
 	{
+	public function delete(array $parameters) : void
+		{
+		$this->getTable(\array_shift($parameters))->delete();
+		}
+
 	/**
-	 * @param array<string, string[]> $parameters containing **\PHPFUI\ORM\Children::class** followed by the child table, then the optional parameters of an order by column and sort order (defaults to ASC).
+	 * @param array<string, string> $parameters containing **\PHPFUI\ORM\Children::class** followed by the child table, then the optional parameters of an order by column and sort order (defaults to ASC).
 	 */
 	public function getValue(array $parameters) : mixed
 		{
-		$child = \array_shift($parameters);
-		$childTable = new $child();
-		$condition = new \PHPFUI\ORM\Condition();
-
-		foreach ($this->currentRecord->getPrimaryKeys() as $primaryKey => $junk)
-			{
-			$condition->and($primaryKey, $this->currentRecord->{$primaryKey});
-			}
-		$childTable->setWhere($condition);
-
+		$childTable = $this->getTable(\array_shift($parameters));
 		$orderBy = \array_shift($parameters);
 		$sort = \array_shift($parameters) ?? 'asc';
 
@@ -43,4 +39,17 @@ public function getValue(array $parameters) : mixed
 
 		return $childTable->getRecordCursor();
 		}
+
+	protected function getTable(string $class) : \PHPFUI\ORM\Table
+		{
+		$childTable = new $class();
+		$condition = new \PHPFUI\ORM\Condition();
+
+		foreach ($this->currentRecord->getPrimaryKeys() as $primaryKey => $junk)
+			{
+			$condition->and($primaryKey, $this->currentRecord->{$primaryKey});
+			}
+
+		return $childTable->setWhere($condition);
+		}
 	}

src/PHPFUI/ORM/Migration.php

@@ -487,6 +487,7 @@ private function alter(string $type, string $table, string $field, string $extra
 	private function getFieldInfo(string $table, string $fieldName) : ?\PHPFUI\ORM\Schema\Field
 		{
 		$fields = \PHPFUI\ORM::describeTable($table);
+
 		foreach ($fields as $field)
 			{
 			if ($field->name == $fieldName)

src/PHPFUI/ORM/Record.php

@@ -27,6 +27,8 @@ abstract class Record extends DataObject
 
 	protected static bool $autoIncrement = false;
 
+	protected static bool $deleteChildren = true;
+
 	protected static array $displayTransforms = [];
 
 	protected bool $empty = true;
@@ -284,19 +286,16 @@ public function create() : int
 	 */
 	public function delete() : bool
 		{
-		// delete child records for primary key only
-		if (1 == \count(static::$primaryKeys))
+		if (static::$deleteChildren)
 			{
-			$primaryKey = \array_key_first(static::$primaryKeys);
-
-			foreach (static::$virtualFields as $relationship => $status)
+			foreach (static::$virtualFields as $field => $relationship)
 				{
-				$childTable = $this->getChildTable($relationship);
+				$relationshipClass = \array_shift($relationship);
 
-				if ($childTable)
+				if (\PHPFUI\ORM\Children::class == $relationshipClass)
 					{
-					$childTable->setWhere(new \PHPFUI\ORM\Condition($primaryKey, $this->current[$primaryKey]));
-					$childTable->delete();
+					$relationshipObject = new \PHPFUI\ORM\Children($this, $field);
+					$relationshipObject->delete($relationship);
 					}
 				}
 			}
@@ -828,20 +827,6 @@ private function buildWhere(array|int|string $key, array &$input) : string
 		return $sql;
 		}
 
-	private function getChildTable(string $relationship) : ?\PHPFUI\ORM\Table
-		{
-		$children = \str_ends_with($relationship, 'Children');
-
-		if (! $children)
-			{
-			return null;
-			}
-		$recordType = \substr($relationship, 0, \strlen($relationship) - 8);
-		$type = '\\' . \PHPFUI\ORM::$tableNamespace . '\\' . $recordType;
-
-		return new $type();
-		}
-
 	/**
 	 * Inserts current data into table
 	 *

src/PHPFUI/ORM/Table.php

@@ -173,11 +173,6 @@ public function addJoin(string $table, string | \PHPFUI\ORM\Condition $on = '',
 		return $this;
 		}
 
-	public function cleanField(string $fieldName) : string
-		{
-		return \preg_replace('/[^[a-zA-Z_][a-zA-Z0-9_.$@-]{0,63}$]/', '', $fieldName);  // string invalid characters since we can't use a placeholder in order and group by
-		}
-
 	public function addOrderBy(string $field, string $ascending = 'ASC') : static
 		{
 		if (\strlen($field))
@@ -265,6 +260,11 @@ public static function capitalSplit(string $key) : string
 		return $output;
 		}
 
+	public function cleanField(string $fieldName) : string
+		{
+		return \preg_replace('/[^[a-zA-Z_][a-zA-Z0-9_.$@-]{0,63}$]/', '', $fieldName);  // string invalid characters since we can't use a placeholder in order and group by
+		}
+
 	/**
 	 * Returns the count for the limited query.
 	 */