Chores: use basic file structure

Author: thomas-kl1

Model/Clean.php

@@ -9,15 +9,18 @@
 namespace Opengento\WebapiLogger\Model;
 
 use Magento\Framework\Exception\LocalizedException;
-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
+use Opengento\WebapiLogger\Model\ResourceModel\Log as LogResource;
 
 class Clean
 {
  public function __construct(
  private Config $config,
- private LogResourceModel $logResourceModel
+ private LogResource $logResourceModel
  ) {}
 
+ /**
+ * @throws LocalizedException
+ */
  public function cleanAll(): void
  {
  $this->logResourceModel->getConnection()->truncateTable($this->logResourceModel->getMainTable());
@@ -32,7 +35,7 @@ public function clean(): void
  $this->logResourceModel->getMainTable(),
  sprintf(
  '%s < NOW() - INTERVAL %s HOUR',
- LogResourceModel::CREATED_AT,
+ LogResource::CREATED_AT,
  $this->config->getCleanOlderThanHours()
  )
  );

Model/Config.php

@@ -13,6 +13,7 @@
 use Opengento\WebapiLogger\Model\Config\SaveMode;
 
 use function array_map;
+use function explode;
 
 class Config
 {
@@ -33,7 +34,7 @@ public function getSaveModes(): array
  {
  return array_map(
  static fn (string $saveMode): SaveMode => SaveMode::from($saveMode),
- $this->scopeConfig->getValue(self::WEBAPI_LOGS_SAVE_MODES)
+ explode(',', (string)$this->scopeConfig->getValue(self::WEBAPI_LOGS_SAVE_MODES))
  );
  }
 

Model/Config/Source/Code.php

@@ -9,20 +9,20 @@
 namespace Opengento\WebapiLogger\Model\Config\Source;
 
 use Magento\Framework\Data\OptionSourceInterface;
-use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;
-use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;
+use Opengento\WebapiLogger\Model\ResourceModel\Log\CollectionFactory;
+use Opengento\WebapiLogger\Model\ResourceModel\Log\Collection;
 
 class Code implements OptionSourceInterface
 {
- public function __construct(private LogCollectionFactory $logCollectionFactory) {}
+ public function __construct(private CollectionFactory $collectionFactory) {}
 
  public function toOptionArray(): array
  {
- /** @var LogCollection $logsCollection */
- $logsCollection = $this->logCollectionFactory->create();
- $logsCollection->addFieldToSelect('response_code');
- $logsCollection->distinct(true);
+ /** @var Collection $collection */
+ $collection = $this->collectionFactory->create();
+ $collection->addFieldToSelect('response_code');
+ $collection->distinct(true);
 
- return $logsCollection->responseCodeToOptionArray();
+ return $collection->responseCodeToOptionArray();
  }
 }

Model/Config/Source/Methods.php

@@ -9,20 +9,20 @@
 namespace Opengento\WebapiLogger\Model\Config\Source;
 
 use Magento\Framework\Data\OptionSourceInterface;
-use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;
-use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;
+use Opengento\WebapiLogger\Model\ResourceModel\Log\CollectionFactory;
+use Opengento\WebapiLogger\Model\ResourceModel\Log\Collection;
 
 class Methods implements OptionSourceInterface
 {
- public function __construct(private LogCollectionFactory $logCollectionFactory) {}
+ public function __construct(private CollectionFactory $collectionFactory) {}
 
  public function toOptionArray(): array
  {
- /** @var LogCollection $logsCollection */
- $logsCollection = $this->logCollectionFactory->create();
- $logsCollection->addFieldToSelect('request_method');
- $logsCollection->distinct(true);
+ /** @var Collection $collection */
+ $collection = $this->collectionFactory->create();
+ $collection->addFieldToSelect('request_method');
+ $collection->distinct(true);
 
- return $logsCollection->requestMethodToOptionArray();
+ return $collection->requestMethodToOptionArray();
  }
 }

Model/Config/Source/RequestorIp.php

@@ -9,20 +9,20 @@
 namespace Opengento\WebapiLogger\Model\Config\Source;
 
 use Magento\Framework\Data\OptionSourceInterface;
-use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollection;
-use Opengento\WebapiLogger\Model\ResourceModel\Entity\LogCollectionFactory;
+use Opengento\WebapiLogger\Model\ResourceModel\Log\CollectionFactory;
+use Opengento\WebapiLogger\Model\ResourceModel\Log\Collection;
 
 class RequestorIp implements OptionSourceInterface
 {
- public function __construct(private LogCollectionFactory $logCollectionFactory) {}
+ public function __construct(private CollectionFactory $collectionFactory) {}
 
  public function toOptionArray(): array
  {
- /** @var LogCollection $logsCollection */
- $logsCollection = $this->logCollectionFactory->create();
- $logsCollection->addFieldToSelect('requestor_ip');
- $logsCollection->distinct(true);
+ /** @var Collection $collection */
+ $collection = $this->collectionFactory->create();
+ $collection->addFieldToSelect('requestor_ip');
+ $collection->distinct(true);
 
- return $logsCollection->requestorIpToOptionArray();
+ return $collection->requestorIpToOptionArray();
  }
 }

Model/Log.php

@@ -9,12 +9,12 @@
 namespace Opengento\WebapiLogger\Model;
 
 use Magento\Framework\Model\AbstractModel;
-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
+use Opengento\WebapiLogger\Model\ResourceModel\Log as LogResource;
 
 class Log extends AbstractModel
 {
  protected function _construct(): void
  {
- $this->_init(LogResourceModel::class);
+ $this->_init(LogResource::class);
  }
 }

Model/LoggerManager.php

@@ -10,15 +10,15 @@
 
 use Magento\Framework\Exception\AlreadyExistsException;
 use Opengento\WebapiLogger\Model\Config\SaveMode;
-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
+use Opengento\WebapiLogger\Model\ResourceModel\Log as LogResource;
 use Psr\Log\LoggerInterface;
 
 use function in_array;
 
 class LoggerManager
 {
  public function __construct(
- private LogResourceModel $logResourceModel,
+ private LogResource $logResourceModel,
  private Config $config,
  private LoggerInterface $logger
  ) {}

Model/ResourceModel/LogResourceModel.php renamed to Model/ResourceModel/Log.php

@@ -10,7 +10,7 @@
 
 use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
 
-class LogResourceModel extends AbstractDb
+class Log extends AbstractDb
 {
  public const CREATED_AT = 'created_at';
 

Model/ResourceModel/Entity/LogCollection.php renamed to Model/ResourceModel/Log/Collection.php

@@ -6,21 +6,21 @@
 
 declare(strict_types=1);
 
-namespace Opengento\WebapiLogger\Model\ResourceModel\Entity;
+namespace Opengento\WebapiLogger\Model\ResourceModel\Log;
 
 use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
 use Opengento\WebapiLogger\Model\Log;
-use Opengento\WebapiLogger\Model\ResourceModel\LogResourceModel;
+use Opengento\WebapiLogger\Model\ResourceModel\Log as LogResource;
 
-class LogCollection extends AbstractCollection
+class Collection extends AbstractCollection
 {
  protected $_idFieldName = 'log_id';
  protected $_eventPrefix = 'webapi_log_collection';
  protected $_eventObject = 'logs_collection';
 
  protected function _construct(): void
  {
- $this->_init(Log::class, LogResourceModel::class);
+ $this->_init(Log::class, LogResource::class);
  }
 
  public function responseCodeToOptionArray(): array

README.md

@@ -49,10 +49,6 @@ bin/magento setup:upgrade
 
 ## Features
 
-### Country to store mapping
-
-Define many countries to many stores relation. This configuration will allows Magento to map stores with countries.
-
 ## Settings
 
 The configuration for this module is available in `Stores > Configuration > System > Webapi Logs`.
@@ -73,6 +69,9 @@ If you disable the Secret Mode this module will logs everything passes in the we
 
 <img src="https://github.com/opengento/magento2-webapi-logger/blob/main/screenshots/screen4.png" />
 
+It is now possible to log the webapi request and response to filesystem or any handler that follow the PSR Log. 
+You can register your handlers to `Opengento\WebapiLogger\Logger`. The module use the `debug` level to log the request and response.
+
 ## Support
 
 Raise a new [request](https://github.com/opengento/magento2-webapi-logger/issues) to the issue tracker.