Add functions for "whole bible"

Author: jkrrv

src/ScripturNum.php

@@ -1338,4 +1338,21 @@ public function toSqlInclusive(string $columnRef): string
 
 		return "( " . implode(" AND ", $r) . " )";
 	}
+
+
+    /**
+     * Get a ScripturNumArray representing the whole Bible.
+     *
+     * @return ScripturNumArray
+     * @throws ScripturNumException -- would only be thrown if there's something peculiar with a custom Bible class.
+     * @since 2.1.0
+     */
+    public static function getWholeBible(): ScripturNumArray
+    {
+        $sna = new ScripturNumArray();
+        foreach (ScripturNum::getBookNames() as $bookNames) {
+            $sna[] = new ScripturNum($bookNames[0]);
+        }
+        return $sna;
+    }
 }

src/ScripturNumArray.php

@@ -24,6 +24,12 @@ class ScripturNumArray implements ArrayAccess, Iterator, Countable
 	protected $hasMultiplePassagesFromAChapter = false;
 
 
+    /**
+     * Constructor
+     *
+     * @param array $initialValues An array of initial values to add to the container. These can be ScripturNum objects
+     * or strings/integers that can be parsed into ScripturNum objects.
+     */
 	public function __construct($initialValues = [])
 	{
 		foreach ($initialValues as $k => $i) {
@@ -61,7 +67,8 @@ protected function sort()
 
 	/**
 	 * @return void
-	 */
+     * @noinspection PhpDocMissingThrowsInspection
+     */
 	protected function combineAdjacents()
 	{
 		$prev = null;
@@ -103,15 +110,15 @@ protected function sortAndCombineIfNeeded()
 	}
 
 	/**
-	 * Whether a offset exists
+	 * Whether an offset exists
 	 * @link https://php.net/manual/en/arrayaccess.offsetexists.php
 	 *
 	 * @param mixed $offset
 	 * An offset to check for.
 	 *
 	 * @return bool true on success or false on failure.
 	 *
-	 * The return value will be casted to boolean if non-boolean was returned.
+	 * The return value will be cast to boolean if non-boolean was returned.
 	 */
 	public function offsetExists($offset): bool
 	{
@@ -220,7 +227,7 @@ public function key()
 	/**
 	 * Checks if current position is valid
 	 * @link https://php.net/manual/en/iterator.valid.php
-	 * @return bool The return value will be casted to boolean and then evaluated.
+	 * @return bool The return value will be cast to boolean and then evaluated.
 	 * Returns true on success or false on failure.
 	 */
 	public function valid(): bool
@@ -260,6 +267,15 @@ public function count(): int
 		return count($this->container);
 	}
 
+    /**
+     * Subtract a passage from this array of passages.
+     *
+     * @since 2.1.0
+     *
+     * @param ScripturNum $other
+     * @return ScripturNumArray
+     * @throws ScripturNumException
+     */
     public function remove(ScripturNum $other): ScripturNumArray
     {
         $result = new ScripturNumArray();
@@ -278,6 +294,15 @@ public function remove(ScripturNum $other): ScripturNumArray
         return $result;
     }
 
+    /**
+     * Subtract all passages in another ScripturNumArray from this array of passages.
+     *
+     * @since 2.1.0
+     *
+     * @param ScripturNumArray $others
+     * @return ScripturNumArray
+     * @throws ScripturNumException
+     */
     public function removeAll(ScripturNumArray $others): ScripturNumArray
     {
         $this->sortAndCombineIfNeeded();

tests/ScripturNumPublicTests.php

@@ -1082,4 +1082,32 @@ public function test_remove_overlapStart()
         $this->assertCount(1, $result);
         $this->assertEquals("Exodus 21", (string)$result);
     }
+
+    /**
+     * @throws ScripturNumException
+     */
+    public function test_getWholeBible()
+    {
+        $s = ScripturNum::getWholeBible();
+        $this->assertCount(66, $s);
+        $this->assertEquals("Revelation", (string)$s[65]);
+    }
+
+    public function test_wholeBibleMinusBook()
+    {
+        $whole = ScripturNum::getWholeBible();
+        $toRemove = new ScripturNum("Exodus");
+        $result = $whole->remove($toRemove);
+        $this->assertCount(65, $result);
+        $this->assertEquals("Leviticus", (string)$result[1]);
+    }
+
+    public function test_wholeBibleMinusChapter()
+    {
+        $whole = ScripturNum::getWholeBible();
+        $toRemove = new ScripturNum("Exodus 1");
+        $result = $whole->remove($toRemove);
+        $this->assertCount(66, $result);
+        $this->assertEquals("Exodus 2-40", (string)$result[1]);
+    }
 }