Added ICollection::fetchChecked() [closes #534]

nextras · Jan 11, 2022 · 29b4dec · 29b4dec
1 parent 60ba3b9
commit 29b4dec
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 0 deletions.
diff --git a/src/Collection/ArrayCollection.php b/src/Collection/ArrayCollection.php
@@ -181,6 +181,16 @@ public function fetch(): ?IEntity
 	}
 
 
+	public function fetchChecked(): IEntity
+	{
+		$entity = $this->fetch();
+		if ($entity === null) {
+			throw new NoResultException();
+		}
+		return $entity;
+	}
+
+
 	public function fetchAll()
 	{
 		return iterator_to_array($this->getIterator());

diff --git a/src/Collection/DbalCollection.php b/src/Collection/DbalCollection.php
@@ -192,6 +192,16 @@ public function fetch(): ?IEntity
 	}
 
 
+	public function fetchChecked(): IEntity
+	{
+		$entity = $this->fetch();
+		if ($entity === null) {
+			throw new NoResultException();
+		}
+		return $entity;
+	}
+
+
 	public function fetchAll()
 	{
 		return iterator_to_array($this->getIterator());

diff --git a/src/Collection/EmptyCollection.php b/src/Collection/EmptyCollection.php
@@ -75,6 +75,16 @@ public function fetch(): ?IEntity
 	}
 
 
+	public function fetchChecked(): IEntity
+	{
+		$entity = $this->fetch();
+		if ($entity === null) {
+			throw new NoResultException();
+		}
+		return $entity;
+	}
+
+
 	public function fetchAll()
 	{
 		return [];

diff --git a/src/Collection/HasManyCollection.php b/src/Collection/HasManyCollection.php
@@ -157,6 +157,16 @@ public function fetch(): ?IEntity
 	}
 
 
+	public function fetchChecked(): IEntity
+	{
+		$entity = $this->fetch();
+		if ($entity === null) {
+			throw new NoResultException();
+		}
+		return $entity;
+	}
+
+
 	public function fetchAll()
 	{
 		return iterator_to_array($this->getIterator());

diff --git a/src/Collection/ICollection.php b/src/Collection/ICollection.php
@@ -168,6 +168,12 @@ public function limitBy(int $limit, int $offset = null): ICollection;
 	 */
 	public function fetch(): ?IEntity;
 
+	/**
+	 * Fetches the first row., throw if none found.
+	 * @throws NoResultException
+	 * @phpstan-return E
+	 */
+	public function fetchChecked(): IEntity;
 
 	/**
 	 * Fetches all records.