Implemented the Exceptions as one liners

only triggered when in development mode and debug is enabled otherwise it will just be a debug log record
elgentos · Jun 6, 2024 · 3b4f6bb · 3b4f6bb
1 parent 5b2271f
commit 3b4f6bb
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 59 deletions.
diff --git a/src/Block/Document.php b/src/Block/Document.php
@@ -3,6 +3,8 @@
 
 namespace Elgentos\PrismicIO\Block;
 
+use Elgentos\PrismicIO\Block\Exception\DocumentIsBrokenException;
+use Elgentos\PrismicIO\Block\Exception\DocumentIsNotFoundException;
 use Elgentos\PrismicIO\Model\Api;
 use Elgentos\PrismicIO\ViewModel\DocumentResolver;
 use Elgentos\PrismicIO\ViewModel\LinkResolver;
@@ -53,6 +55,7 @@ private function fetchChildDocument(): bool
 
         $isBroken = (bool)($context->isBroken ?? true);
         if ($isBroken) {
+            DocumentIsBrokenException::throwException($this);
             // We can only query existing pages
             return false;
         }
@@ -67,6 +70,7 @@ private function fetchChildDocument(): bool
         }
 
         if (! $document) {
+            DocumentIsNotFoundException::throwException($this);
             return false;
         }
 

diff --git a/src/Block/Group.php b/src/Block/Group.php
@@ -8,12 +8,15 @@
 
 namespace Elgentos\PrismicIO\Block;
 
+use Elgentos\PrismicIO\Block\Exception\GroupExpectsAnArrayException;
+
 class Group extends AbstractBlock
 {
     public function fetchDocumentView(): string
     {
         $items = $this->getContext();
         if (! is_array($items)) {
+            GroupExpectsAnArrayException::throwException($this);
             return '';
         }
 

diff --git a/src/Block/SliceBlock.php b/src/Block/SliceBlock.php
@@ -2,6 +2,8 @@
 
 namespace Elgentos\PrismicIO\Block;
 
+use Elgentos\PrismicIO\Block\Exception\SliceBlockNotFoundException;
+
 class SliceBlock extends AbstractBlock
 {
     protected function _toHtml(): string
@@ -17,6 +19,7 @@ public function fetchDocumentView(): string
 
         $block = $layout->getBlock($reference);
         if (! ($block instanceof BlockInterface)) {
+            SliceBlockNotFoundException::throwException($this);
             return '';
         }
 

diff --git a/src/Block/SliceVariation.php b/src/Block/SliceVariation.php
@@ -2,18 +2,29 @@
 
 namespace Elgentos\PrismicIO\Block;
 
+use Elgentos\PrismicIO\Block\Exception\SliceVariationNotFoundException;
+use Elgentos\PrismicIO\Block\Exception\SliceVariationNoVariationException;
+
 class SliceVariation extends AbstractBlock
 {
     public function fetchDocumentView(): string
     {
         $context = $this->getContext();
         $variation = $context->variation ?: null;
         if (! $variation) {
+            SliceVariationNoVariationException::throwException($this);
             return '';
         }
 
         $block = $this->getChildBlock($variation);
         if (! ($block instanceof BlockInterface)) {
+            SliceVariationNotFoundException::throwException(
+                $this,
+                [
+                    'variation' => $variation,
+                ],
+            );
+
             return '';
         }
 

diff --git a/src/Block/Slices.php b/src/Block/Slices.php
@@ -4,12 +4,17 @@
 
 namespace Elgentos\PrismicIO\Block;
 
+use Elgentos\PrismicIO\Block\Exception\SliceNotFoundException;
+
 class Slices extends Group
 {
     public function fetchItem(\stdClass $slice, $key = null): string
     {
         $sliceTypeBlock = $this->getSliceTypeBlock($slice->slice_type);
         if (null === $sliceTypeBlock) {
+            SliceNotFoundException::throwException($this, [
+                'slice_type' => $slice->slice_type,
+            ]);
             return '';
         }
 

diff --git a/src/Block/StaticBlock.php b/src/Block/StaticBlock.php
@@ -2,64 +2,39 @@
 
 namespace Elgentos\PrismicIO\Block;
 
-use Elgentos\PrismicIO\Exception\ApiNotEnabledException;
+use Elgentos\PrismicIO\Block\Exception\StaticBlockNotFoundException;
 use Elgentos\PrismicIO\Exception\ContextNotFoundException;
 use Elgentos\PrismicIO\Exception\DocumentNotFoundException;
 use Elgentos\PrismicIO\Model\Api;
 use Elgentos\PrismicIO\ViewModel\DocumentResolver;
 use Elgentos\PrismicIO\ViewModel\LinkResolver;
-use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\View\Element\Context;
-use Psr\Log\LoggerInterface;
-use stdClass;
 
 class StaticBlock extends AbstractBlock
 {
-    private Api $api;
-
-    private LoggerInterface $logger;
-
-    private string $contentType;
-
-    private ?string $identifier;
-
     public function __construct(
-        Context $context,
-        DocumentResolver $documentResolver,
-        LinkResolver $linkResolver,
-        Api $api,
-        LoggerInterface $logger,
-        string $contentType = 'static_block',
-        string $identifier = null,
-        array $data = []
+        Context                  $context,
+        DocumentResolver         $documentResolver,
+        LinkResolver             $linkResolver,
+        private readonly Api     $api,
+        private readonly string  $contentType = 'static_block',
+        private readonly ?string $identifier = null,
+        array                    $data = []
     ) {
         parent::__construct($context, $documentResolver, $linkResolver, $data);
-        $this->api = $api;
-        $this->logger = $logger;
-        $this->contentType = $contentType;
-        $this->identifier = $identifier;
     }
 
-    /**
-     * @return string
-     * @throws NoSuchEntityException
-     */
     protected function _toHtml(): string
     {
         $this->createPrismicDocument();
         return parent::_toHtml();
     }
 
-    /**
-     * @return void
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
-     */
     private function createPrismicDocument(): void
     {
         $contentType = $this->contentType;
         $identifier  = $this->identifier;
 
-
         // Allow using "template" to reference a document (saves XML)
         $reference = $this->getReference();
         if ($reference !== '*') {
@@ -79,6 +54,7 @@ private function createPrismicDocument(): void
             return;
         }
 
+        // Create a document
         $document = new \stdClass;
         $options  = $this->api->getOptions();
 
@@ -96,19 +72,15 @@ private function createPrismicDocument(): void
      */
     public function fetchDocumentView(): string
     {
-        try {
-            if (!$this->fetchChildDocument()) {
-                return '';
-            }
-        } catch (\Exception $e) {
-            $this->logger->error($e->getMessage());
+        if (! $this->fetchChildDocument()) {
             return '';
         }
 
+        // Render all children
         $html = '';
         foreach ($this->getChildNames() as $childName) {
-                $useCache = ! $this->updateChildDocumentWithDocument($childName);
-                $html    .= $this->getChildHtml($childName, $useCache);
+            $useCache = ! $this->updateChildDocumentWithDocument($childName);
+            $html    .= $this->getChildHtml($childName, $useCache);
         }
 
         return $html;
@@ -129,13 +101,16 @@ private function fetchChildDocument(): bool
         $uid  = $context->uid ?? '';
         $type = $context->type ?? '';
 
-        try {
-            $document = $this->api->getDocumentByUid($uid, $type, ['lang' => $context->lang]);
-        } catch (\Exception $e) {
-            return false;
-        }
-
+        $document = $this->api->getDocumentByUid($uid, $type, ['lang' => $context->lang]);
         if (! $document) {
+            StaticBlockNotFoundException::throwException(
+                $this,
+                [
+                    'uid' => $uid,
+                    'content_type' => $type,
+                    'language' => $context->lang,
+                ]
+            );
             return false;
         }
 

diff --git a/src/Model/Api.php b/src/Model/Api.php
@@ -235,12 +235,7 @@ public function getDocumentByUid(string $uid, string $contentType = null, array
             return null;
         }
 
-        try {
-            $document = $api->getByUID($contentType, $uid, $this->getOptions($options));
-        } catch (Exception $e) {
-            return null;
-        }
-
+        $document = $api->getByUID($contentType, $uid, $this->getOptions($options));
         if ($document || ! $this->isFallbackAllowed()) {
             return $document;
         }
@@ -292,12 +287,8 @@ public function getSingleton(string $contentType = null, array $options = []): ?
      */
     public function getDocumentById(string $id, array $options = []): ?\stdClass
     {
-        $api = $this->create();
-        try {
-            return $api->getByID($id, $this->getOptions($options));
-        } catch (Exception $e) {
-            return null;
-        }
+        return $this->create()
+                ->getByID($id, $this->getOptions($options));
     }
 
 }