Add product collections

.gitignore

@@ -0,0 +1,2 @@
+vendor
+.idea

Helper/Settings.php

@@ -34,10 +34,10 @@ public function __construct(
      * Log an error message.
      *
      * @param string $message
-     * @param $resource
+     * @param mixed $resource
      * @return void
      */
-    public function logError(string $message = "", $resource = null): void
+    public function logError(string $message = "", mixed $resource = null): void
     {
         $this->logger->error(
             self::LOG_PREFIX .

composer.json

@@ -1,10 +1,10 @@
 {
     "name": "deployecommerce/module-builderio",
-    "version": "1.0.16",
+    "version": "1.1.0",
     "description": "A magento 2 extensions that renders Builder.io content.",
     "type": "magento2-module",
     "require": {
-        "php": "~8.1.0|~8.2.0|~8.3.0|~8.4.0",
+        "php": "~8.1.0|~8.2.0|~8.3.0|~8.4.0|~8.5.0",
         "magento/framework": "*",
         "magento/module-store": "*",
         "magento/module-cms": "*",

Api/Data/WebhookSearchResultsInterface.php → src/BuilderIO/Api/Data/WebhookSearchResultsInterface.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Block/System/Config/Connect.php → src/BuilderIO/Block/System/Config/Connect.php

@@ -11,7 +11,9 @@
 
 use DeployEcommerce\BuilderIO\System\Config;
 use Magento\Backend\Block\Template\Context;
+use Magento\Backend\Block\Widget\Button;
 use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\View\Helper\SecureHtmlRenderer;
 
@@ -46,7 +48,6 @@ public function __construct(
         parent::__construct($context, $data, $secureRenderer);
     }
 
-
     /**
      * Return element html
      *
@@ -55,7 +56,7 @@ public function __construct(
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
+    protected function _getElementHtml(AbstractElement $element)
     {
         return $this->_toHtml();
     }
@@ -79,7 +80,7 @@ public function getAjaxConnectUrl()
     public function getButtonHtml()
     {
         $button = $this->getLayout()->createBlock(
-            \Magento\Backend\Block\Widget\Button::class
+            Button::class
         )->setData(
             [
                 'id' => 'connect_button',

Block/System/Config/Content.php → src/BuilderIO/Block/System/Config/Content.php

@@ -9,7 +9,11 @@
 
 namespace DeployEcommerce\BuilderIO\Block\System\Config;
 
+use Magento\Backend\Block\Template;
+use Magento\Backend\Block\Widget\Button;
 use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
+use Magento\Framework\Data\Form\Element\Renderer\RendererInterface;
 use Magento\Framework\Exception\LocalizedException;
 
 /**
@@ -19,8 +23,8 @@
  * It extends the Magento Form Field and uses a custom template to render the button.
  *
  */
-class Content extends \Magento\Backend\Block\Template implements
-    \Magento\Framework\Data\Form\Element\Renderer\RendererInterface
+class Content extends Template implements
+    RendererInterface
 {
     /**
      * @var string
@@ -35,7 +39,7 @@ class Content extends \Magento\Backend\Block\Template implements
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
+    protected function _getElementHtml(AbstractElement $element)
     {
         return $this->_toHtml();
     }
@@ -59,7 +63,7 @@ public function getAjaxSyncUrl()
     public function getButtonHtml()
     {
         $button = $this->getLayout()->createBlock(
-            \Magento\Backend\Block\Widget\Button::class
+            Button::class
         )->setData(
             [
                 'id' => 'connect_button',
@@ -73,7 +77,7 @@ public function getButtonHtml()
     /**
      * @inheritDoc
      */
-    public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
+    public function render(AbstractElement $element)
     {
         return $this->_getElementHtml($element);
     }

Block/System/Config/Fields.php → src/BuilderIO/Block/System/Config/Fields.php

@@ -11,7 +11,9 @@
 
 use DeployEcommerce\BuilderIO\System\Config;
 use Magento\Backend\Block\Template\Context;
+use Magento\Backend\Block\Widget\Button;
 use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\View\Helper\SecureHtmlRenderer;
 
@@ -54,7 +56,7 @@ public function __construct(
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
+    protected function _getElementHtml(AbstractElement $element)
     {
         return $this->_toHtml();
     }
@@ -78,7 +80,7 @@ public function getAjaxConnectUrl()
     public function getButtonHtml()
     {
         $button = $this->getLayout()->createBlock(
-            \Magento\Backend\Block\Widget\Button::class
+            Button::class
         )->setData(
             [
                 'id' => 'fields_button',

Block/System/Config/Webhook.php → src/BuilderIO/Block/System/Config/Webhook.php

@@ -11,7 +11,9 @@
 
 use DeployEcommerce\BuilderIO\System\Config;
 use Magento\Backend\Block\Template\Context;
+use Magento\Backend\Block\Widget\Button;
 use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\View\Helper\SecureHtmlRenderer;
 
@@ -54,7 +56,7 @@ public function __construct(
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
+    protected function _getElementHtml(AbstractElement $element)
     {
         return $this->_toHtml();
     }
@@ -78,7 +80,7 @@ public function getAjaxConnectUrl()
     public function getButtonHtml()
     {
         $button = $this->getLayout()->createBlock(
-            \Magento\Backend\Block\Widget\Button::class
+            Button::class
         )->setData(
             [
                 'id' => 'webhook_button',

Controller/Adminhtml/Content/Page.php → src/BuilderIO/Controller/Adminhtml/Content/Page.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Controller/View/Index.php → src/BuilderIO/Controller/View/Index.php

@@ -11,7 +11,6 @@
 
 use DeployEcommerce\BuilderIO\Api\ContentPageRepositoryInterface;
 use DeployEcommerce\BuilderIO\Helper\Settings;
-use DeployEcommerce\BuilderIO\Model\WebhookRepository;
 use DeployEcommerce\BuilderIO\Registry\CurrentPageContent;
 use DeployEcommerce\BuilderIO\Service\BuilderIO\Page as PageService;
 use DeployEcommerce\BuilderIO\System\Config;

Controller/View/Page.php → src/BuilderIO/Controller/View/Page.php

@@ -11,7 +11,6 @@
 
 use DeployEcommerce\BuilderIO\Api\ContentPageRepositoryInterface;
 use DeployEcommerce\BuilderIO\Helper\Settings;
-use DeployEcommerce\BuilderIO\Model\WebhookRepository;
 use DeployEcommerce\BuilderIO\Registry\CurrentPageContent;
 use DeployEcommerce\BuilderIO\Service\BuilderIO\Page as PageService;
 use Magento\Cms\Controller\Page\View;

Controller/Webhooks/Page.php → src/BuilderIO/Controller/Webhooks/Page.php

@@ -14,6 +14,7 @@
 use DeployEcommerce\BuilderIO\Model\Queue\Handler\Handler;
 use DeployEcommerce\BuilderIO\Api\WebhookRepositoryInterface;
 use DeployEcommerce\BuilderIO\System\Config;
+use Exception;
 use GuzzleHttp\Exception\GuzzleException;
 use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\CsrfAwareActionInterface;
@@ -145,7 +146,7 @@ public function execute()
                     $this->handler->execute($webhook->getWebhookId());
                 }
 
-            } catch (\Exception $e) {
+            } catch (Exception $e) {
                 $this->logger->error($e->getMessage());
             }
         }

Controller/Webhooks/Section.php → src/BuilderIO/Controller/Webhooks/Section.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Cron/CleanWebhooksCronjob.php → src/BuilderIO/Cron/CleanWebhooksCronjob.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

src/BuilderIO/Helper/Settings.php

@@ -0,0 +1,48 @@
+<?php
+/*
+ * @Author:    Dan Lewis (dan.lewis@deploy.co.uk)
+ * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)
+ * @Package:   DeployEcommerce_BuilderIO
+ */
+
+declare(strict_types=1);
+
+namespace DeployEcommerce\BuilderIO\Helper;
+
+use Magento\Framework\App\Helper\AbstractHelper;
+use Magento\Framework\App\Helper\Context;
+use Psr\Log\LoggerInterface;
+
+class Settings extends AbstractHelper
+{
+    public const LOG_PREFIX = "DeployEcommerce - Builder IO";
+
+    /**
+     * Settings constructor.
+     *
+     * @param Context $context
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        public Context                  $context,
+        protected LoggerInterface       $logger
+    ) {
+        parent::__construct($context);
+    }
+
+    /**
+     * Log an error message.
+     *
+     * @param string $message
+     * @param $resource
+     * @return void
+     */
+    public function logError(string $message = "", $resource = null): void
+    {
+        $this->logger->error(
+            self::LOG_PREFIX .
+            " - ERROR - " .
+            $message
+        );
+    }
+}

Model/Cache/Type/BuilderIOContent.php → src/BuilderIO/Model/Cache/Type/BuilderIOContent.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Dan Lewis (dan.lewis@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Model/Config/Source/Pages.php → src/BuilderIO/Model/Config/Source/Pages.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)
@@ -18,6 +19,12 @@
  */
 class Pages implements OptionSourceInterface
 {
+    /**
+     * Pages constructor.
+     *
+     * @param ContentPageRepository $contentPageRepository
+     * @param SearchCriteriaBuilder $searchCriteriaBuilder
+     */
     public function __construct(
         private ContentPageRepository $contentPageRepository,
         private SearchCriteriaBuilder $searchCriteriaBuilder

Model/ContentPageModel.php → src/BuilderIO/Model/ContentPageModel.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Model/ContentPageRepository.php → src/BuilderIO/Model/ContentPageRepository.php

@@ -17,6 +17,7 @@
 use Magento\Framework\Exception\CouldNotSaveException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Throwable;
 
 class ContentPageRepository implements ContentPageRepositoryInterface
 {
@@ -49,7 +50,7 @@ public function save(ContentPageInterface $contentPage): ContentPageInterface
                 __('Could not save the webhook: %1', $exception->getMessage()),
                 $exception
             );
-        } catch (\Throwable $exception) {
+        } catch (Throwable $exception) {
             // todo fix the exception handling
 //            throw new CouldNotSaveException(
 //                __('Could not save the webhook: %1', __('Something went wrong while saving the ContentPage.')),

Model/ContentSectionModel.php → src/BuilderIO/Model/ContentSectionModel.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Model/ContentStructuredDataModel.php → src/BuilderIO/Model/ContentStructuredDataModel.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /*
  * @Author:    Nathan Chick (nathan.chick@deploy.co.uk)
  * @Copyright: 2024 Deploy Ecommerce (https://www.deploy.co.uk/)

Model/PageUrlRewriteGenerator.php → src/BuilderIO/Model/PageUrlRewriteGenerator.php

@@ -23,7 +23,7 @@ class PageUrlRewriteGenerator
     /**
      * Entity type code
      */
-    const ENTITY_TYPE = 'builderio-page';
+    public const ENTITY_TYPE = 'builderio-page';
 
     /**
      * Page model

Model/Queue/Handler/Handler.php → src/BuilderIO/Model/Queue/Handler/Handler.php

@@ -16,6 +16,7 @@
 use DeployEcommerce\BuilderIO\Model\WebhookModel;
 use DeployEcommerce\BuilderIO\Service\BuilderIO\Page as PageService;
 use DeployEcommerce\BuilderIO\System\Config;
+use Exception;
 use GuzzleHttp\Exception\GuzzleException;
 use Magento\UrlRewrite\Model\UrlRewriteFactory;
 use Magento\Framework\Serialize\Serializer\Json;
@@ -107,7 +108,7 @@ private function processPage()
 
         try {
             $contentPage = $this->contentPageRepository->findByBuilderioPageId($page['id']);
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $contentPage = $this->contentPageFactory->create();
         }
 
@@ -133,17 +134,22 @@ private function processPage()
 
         try {
             $this->contentPageRepository->save($contentPage);
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error($e->getMessage());
         }
     }
 
+    /**
+     * Delete the page associated with the webhook.
+     *
+     * @return void
+     */
     private function deletePage()
     {
         try {
             $contentPage = $this->contentPageRepository->findByBuilderioPageId($this->webhook->getBuilderioId());
             $this->contentPageRepository->delete($contentPage);
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error($e->getMessage());
         }
     }