Cursors should return zero based keys

Author: phpfui

Tests/Unit/CursorTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Tests\Unit;
+
+class CursorTest extends \PHPUnit\Framework\TestCase
+	{
+	public function testCursor() : void
+		{
+		$table = new \Tests\App\Table\Customer();
+		$table->addOrderBy('customer_id');
+
+		$index = 0;
+		foreach ($table->getRecordCursor() as $key => $record)
+			{
+			$this->assertEquals($index++, $key, 'RecordCursor key is not correct');
+			$this->assertEquals($index, $record->customer_id, 'RecordCursor record is not correct');
+			$this->assertEquals($index, $record['customer_id'], 'RecordCursor array access is not correct');
+			}
+
+		$index = 0;
+		foreach ($table->getArrayCursor() as $key => $record)
+			{
+			$this->assertEquals($index++, $key, 'ArrayCursor key is not correct');
+			$this->assertEquals($index, $record['customer_id'], 'ArrayCursor record is not correct');
+			}
+
+		$index = 0;
+		foreach ($table->getDataObjectCursor() as $key => $record)
+			{
+			$this->assertEquals($index++, $key, 'DataObjectCursor key is not correct');
+			$this->assertEquals($index, $record->customer_id, 'DataObjectCursor record is not correct');
+			$this->assertEquals($index, $record['customer_id'], 'DataObjectCursor array access is not correct');
+			}
+		}
+	}

src/PHPFUI/ORM/BaseCursor.php

@@ -9,7 +9,7 @@
  */
 abstract class BaseCursor implements \Countable, \Iterator	// @phpstan-ignore-line
 	{
-	protected int $index = -1;
+	protected ?int $index = null;
 
 	private ?int $count = null;
 
@@ -27,7 +27,7 @@ public function __construct(protected ?\PDOStatement $statement = null, protecte
 	public function __destruct()
 		{
 		$this->statement?->closeCursor();
-		$this->index = -1;
+		$this->index = null;
 		$this->total = null;
 		$this->count = null;
 		}
@@ -68,7 +68,7 @@ public function key() : int
 		{
 		$this->init();
 
-		return $this->index;
+		return (int)$this->index;
 		}
 
 	/**
@@ -81,7 +81,7 @@ abstract public function next() : void;
 	 */
 	public function rewind() : void
 		{
-		$this->index = 0;
+		$this->index = -1;
 
 		if (! $this->statement)
 			{
@@ -158,7 +158,7 @@ abstract public function valid() : bool;
 	 */
 	protected function init() : void
 		{
-		if (-1 == $this->index)
+		if (null === $this->index)
 			{
 			$this->rewind();
 			}