Merge pull request #3 from magmodules/release/1.1.0

Release/1.1.0
magmodules · Apr 25, 2024 · 816df6e · 816df6e
2 parents 6c9fbe1 + eee1a34
commit 816df6e
Show file tree

Hide file tree

Showing 58 changed files with 1,384 additions and 1,748 deletions.
diff --git a/Api/Log/RepositoryInterface.php b/Api/Log/RepositoryInterface.php
@@ -13,21 +13,54 @@
 interface RepositoryInterface
 {
 
+    /**
+     * Limit stream size to 100 lines
+     */
+    public const STREAM_DEFAULT_LIMIT = 100;
+
+    /**
+     * Log file path pattern
+     */
+    public const LOG_FILE = '%s/log/messagebird-%s.log';
+
     /**
      * Add record to error log
      *
      * @param string $type
      * @param mixed $data
-     *
      */
-    public function addErrorLog(string $type, $data);
+    public function addErrorLog(string $type, $data): void;
 
     /**
      * Add record to debug log
      *
      * @param string $type
      * @param mixed $data
+     */
+    public function addDebugLog(string $type, $data): void;
+
+    /**
+     * Add record to log
+     *
+     * @param string $type
+     * @param mixed $data
+     */
+    public function addLog(string $type, $data): void;
+
+    /**
+     * Returns path of logfile
+     *
+     * @param string $type
+     * @return string
+     */
+    public function getLogFilePath(string $type): ?string;
+
+    /**
+     * Return log entries as sorted array
      *
+     * @param string $path
+     * @param int|null $limit
+     * @return array|null
      */
-    public function addDebugLog(string $type, $data);
+    public function getLogEntriesAsArray(string $path, ?int $limit = null): ?array;
 }
diff --git a/Block/Adminhtml/MessageBird/Header.php → Block/Adminhtml/Design/Header.php b/Block/Adminhtml/MessageBird/Header.php → Block/Adminhtml/Design/Header.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magmodules\MessageBird\Block\Adminhtml\MessageBird;
+namespace Magmodules\MessageBird\Block\Adminhtml\Design;
 
 use Magento\Config\Block\System\Config\Form\Field;
 use Magento\Framework\Data\Form\Element\AbstractElement;

diff --git a/Block/Adminhtml/MessageBird/Heading.php → Block/Adminhtml/Design/Heading.php b/Block/Adminhtml/MessageBird/Heading.php → Block/Adminhtml/Design/Heading.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magmodules\MessageBird\Block\Adminhtml\MessageBird;
+namespace Magmodules\MessageBird\Block\Adminhtml\Design;
 
 use Magento\Config\Block\System\Config\Form\Field;
 use Magento\Framework\Data\Form\Element\AbstractElement;
@@ -26,8 +26,8 @@ public function render(AbstractElement $element): string
         $html = '<tr id="row_' . $element->getHtmlId() . '">';
         $html .= '  <td class="label"></td>';
         $html .= '  <td class="value">';
-        $html .= '     <div class="magmodules-messagebird-heading-block">' . $element->getData('label') . '</div>';
-        $html .= '     <div class="magmodules-messagebird-heading-comment">' . $element->getData('comment') . '</div>';
+        $html .= '     <div class="mm-ui-heading-block">' . $element->getData('label') . '</div>';
+        $html .= '     <div class="mm-ui-heading-comment">' . $element->getData('comment') . '</div>';
         $html .= '  </td>';
         $html .= '  <td></td>';
         $html .= '</tr>';

diff --git a/Block/Adminhtml/System/Config/Button/Credentials.php b/Block/Adminhtml/System/Config/Button/Credentials.php
@@ -83,19 +83,19 @@ public function getApiCheckUrl()
     }
 
     /**
-     * @return mixed
+     * @return string
      */
-    public function getButtonHtml()
+    public function getButtonHtml(): string
     {
-        $buttonData = ['id' => 'messagebird-button_credentials', 'label' => __('Check Credentials')];
         try {
-            $button = $this->getLayout()->createBlock(
-                Button::class
-            )->setData($buttonData);
-            return $button->toHtml();
+            return $this->getLayout()
+                ->createBlock(Button::class)
+                ->setData([
+                    'id' => 'mm-ui-button_credentials',
+                    'label' => __('Check Credentials')
+                ])->toHtml();
         } catch (Exception $e) {
-            $this->logger->addErrorLog('LocalizedException', $e->getMessage());
-            return false;
+            return '';
         }
     }
 }
diff --git a/Block/Adminhtml/System/Config/Button/DebugCheck.php b/Block/Adminhtml/System/Config/Button/DebugCheck.php
diff --git a/Block/Adminhtml/System/Config/Button/ErrorCheck.php b/Block/Adminhtml/System/Config/Button/ErrorCheck.php
diff --git a/Block/Adminhtml/System/Config/Button/Log.php b/Block/Adminhtml/System/Config/Button/Log.php
@@ -0,0 +1,74 @@
+<?php
+/**
+ * Copyright © Magmodules.eu. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magmodules\MessageBird\Block\Adminhtml\System\Config\Button;
+
+use Exception;
+use Magento\Backend\Block\Widget\Button;
+use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
+use Magmodules\MessageBird\Api\Log\RepositoryInterface as LogRepository;
+
+/**
+ * Log check button class
+ */
+class Log extends Field
+{
+
+    /**
+     * @var string
+     */
+    protected $_template = 'Magmodules_MessageBird::system/config/button/log.phtml';
+
+    /**
+     * @param AbstractElement $element
+     *
+     * @return string
+     */
+    public function render(AbstractElement $element): string
+    {
+        $element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
+        return parent::render($element);
+    }
+
+    /**
+     * @param AbstractElement $element
+     *
+     * @return string
+     */
+    public function _getElementHtml(AbstractElement $element): string
+    {
+        return $this->_toHtml();
+    }
+
+    /**
+     * @param string $type
+     * @return string
+     */
+    public function getDownloadUrl(string $type): string
+    {
+        return $this->getUrl('messagebird/log/stream', ['type' => $type]);
+    }
+
+    /**
+     * @param string $type
+     * @return string
+     */
+    public function getButtonHtml(string $type): string
+    {
+        try {
+            return $this->getLayout()
+                ->createBlock(Button::class)
+                ->setData([
+                    'id' => 'mm-ui-button_' . $type,
+                    'label' => __('Show last %1 %2 log records', LogRepository::STREAM_DEFAULT_LIMIT, $type)
+                ])->toHtml();
+        } catch (Exception $e) {
+            return '';
+        }
+    }
+}