Adding initial classes to output Bible text - #239

Author: bfren

src/classes/netbible/api.class.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Obadiah\NetBible;
+
+use Obadiah\App;
+use Obadiah\Helpers\Log;
+
+App::check();
+
+class Api
+{
+    /**
+     * Create API object.
+     *
+     */
+    public function __construct() {}
+
+    /**
+     * Get a passage from the NET Bible API.
+     *
+     * @param string $passage                       The passage to retrieve - multiple passages should be separated by a semi-colon.
+     * @param string $type                          The return type - either 'text' (default) or 'json'.
+     * @return mixed                                If $passage is a valid Bible reference, the NET Bible text of that passage.
+     */
+    private function get(string $passage, string $type = "text"): mixed
+    {
+        // build URL from data
+        $formatting = match($type) {
+            "text" => "para",
+            default => "plain"
+        };
+        $url = sprintf("https://labs.bible.org/api/?passage=%s&type=%s&formatting=%s", urlencode($passage), $type, $formatting);
+
+        // create curl request
+        $handle = curl_init($url);
+        if ($handle === false) {
+            _l("Unable to create cURL request for %s.", $url);
+            return null;
+        }
+
+        curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
+
+        // make request - on error log and return null
+        $response = curl_exec($handle);
+        if (!is_string($response)) {
+            _l(print_r(curl_error($handle), true));
+            return null;
+        }
+
+        // if type is JSON, decode and return
+        if ($type === "json") {
+            $json = json_decode($response);
+            if (!$json) {
+                _l("Unable to decode JSON response from %s.", $url);
+                return null;
+            }
+
+            return $json;
+        }
+
+        // otherwise return as text
+        return $response;
+    }
+
+    /**
+     * Get Bible passage as JSON.
+     *
+     * @param string $passage                       The passage to retrieve - multiple passages should be separated by a semi-colon.
+     * @return mixed                                If $passage is a valid Bible reference, the NET Bible text of that passage.
+     */
+    public function get_json(string $passage): mixed
+    {
+        return $this->get($passage, "json");
+    }
+
+    /**
+     * Get Bible passage as (HTML-formatted) text.
+     *
+     * @param string $passage                       The passage to retrieve - multiple passages should be separated by a semi-colon.
+     * @return ?string                              If $passage is a valid Bible reference, the NET Bible text of that passage.
+     */
+    public function get_text(string $passage): ?string
+    {
+        return $this->get($passage, "text");
+    }
+}

src/pages/about/about.class.php

@@ -11,7 +11,7 @@
 class About extends Endpoint
 {
     /**
-     * GET: /
+     * GET: /about
      *
      * @return View
      */

src/pages/bible/bible.class.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Obadiah\Pages\Bible;
+
+use Obadiah\App;
+use Obadiah\NetBible\Api;
+use Obadiah\Request\Request;
+use Obadiah\Response\View;
+use Obadiah\Router\Endpoint;
+
+App::check();
+
+class Bible extends Endpoint
+{
+    /**
+     * GET: /bible
+     *
+     * @return View
+     */
+    public function index_get(): View
+    {
+        // get the requested passage reference
+        $passage = Request::$get->string("passage", "");
+
+        // use the API to get the Bible text
+        $netbible = new Api();
+        $text = $netbible->get_text($passage);
+
+        // format the passage reference with uppercase words
+        return new View("bible", model: new Index_Model(ucwords($passage), $text));
+    }
+}

src/pages/bible/index-model.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Obadiah\Pages\Bible;
+
+use Obadiah\App;
+
+App::check();
+
+class Index_Model
+{
+    /**
+     * Create Index model.
+     *
+     * @param @string $ref                          The Bible passage reference.
+     * @param ?string $text                         The text of the requested Bible passage.
+     */
+    public function __construct(
+        public readonly ?string $ref,
+        public readonly ?string $text
+    ) {}
+}

src/pages/bible/index-view.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Obadiah\Pages\Bible;
+
+use Obadiah\App;
+use Obadiah\Pages\Bible\Index_Model;
+use Obadiah\Pages\Parts\Header\Header_Model;
+use Obadiah\Response\View;
+
+App::check();
+
+/** @var View $this */
+/** @var Index_Model $model */
+
+// output header
+$this->header(new Header_Model("Bible", subtitle: "Access the Bible text using the New English Translation (NET)."));
+
+?>
+
+<div>
+    <h2><?php _e($model->ref); ?></h2>
+    <?php _h($model->text); ?>
+</div>
+
+<?php
+
+$this->footer();

src/pages/parts/header/nav-part.php

@@ -18,6 +18,7 @@
         "Home" => "/",
         "Rota" => "/rota",
         "Refresh" => "/refresh",
+        "Bible" => "/bible",
         "About" => "/about",
         "Log Out" => "/auth/logout"
     );
@@ -27,9 +28,9 @@
             array("Upload" => "/upload"),
             array_slice($links, 1, 1),
             array("Prayer Calendar" => "/prayer"),
-            array_slice($links, 2, 1),
+            array_slice($links, 3, 1),
             array("Settings" => "/settings"),
-            array_slice($links, 3),
+            array_slice($links, 4),
         );
     }
 } else {

src/public/index.php

@@ -17,16 +17,17 @@
 Router::map_endpoint(A\Safeguarding\Safeguarding::class, uri_prefix: API_PREFIX);
 
 // map pages
+Router::map_endpoint(P\About\About::class);
 Router::map_endpoint(P\Auth\Auth::class, requires_auth: false);
+Router::map_endpoint(P\Bible\Bible::class);
 Router::map_endpoint(P\Events\Events::class, requires_auth: false);
 Router::map_endpoint(P\Prayer\Prayer::class, requires_admin: true);
 Router::map_endpoint(P\Refresh\Refresh::class);
 Router::map_endpoint(P\Robots\Robots::class, uri_path: "robots.txt", requires_auth: false);
 Router::map_endpoint(P\Rota\Rota::class);
 Router::map_endpoint(P\Services\Services::class, requires_auth: false);
-Router::map_endpoint(P\Upload\Upload::class, requires_admin: true);
 Router::map_endpoint(P\Settings\Settings::class, requires_admin: true);
-Router::map_endpoint(P\About\About::class);
+Router::map_endpoint(P\Upload\Upload::class, requires_admin: true);
 
 // get and execute page action
 $action = Router::get_action();