Refactor all utils classes

basecom · Jun 3, 2024 · 2d1af0d · 2d1af0d
1 parent 8dd4d83
commit 2d1af0d
Show file tree

Hide file tree

Showing 12 changed files with 205 additions and 86 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - CategoryUtils
   - Removed method `getFirst` on CategoryUtils
   - Removed method `getByName` on CategoryUtils
+- Renamed `CategoryUtils` to `SalutationUtils`
 
 ## [2.4.0] - 2023-11-15
 ### Added

diff --git a/_examples/CustomerFixture.php b/_examples/CustomerFixture.php
@@ -32,7 +32,7 @@ public function load(FixtureBag $bag): void
             'defaultPaymentMethodId' => $this->helper->PaymentMethod()->getInvoicePaymentMethod()->getId(),
             'defaultBillingAddress'  => [
                 'id'           => self::ADDRESS_ID,
-                'salutationId' => $this->helper->Customer()->getNotSpecifiedSalutation()->getId(),
+                'salutationId' => $this->helper->Salutation()->getNotSpecifiedSalutation()->getId(),
                 'firstName'    => 'John',
                 'lastName'     => 'Doe',
                 'zipcode'      => '1234',
@@ -41,7 +41,7 @@ public function load(FixtureBag $bag): void
                 'countryId'    => $this->helper->SalesChannel()->getCountry('DE')->getId(),
             ],
             'defaultShippingAddressId' => self::ADDRESS_ID,
-            'salutationId'             => $this->helper->Customer()->getNotSpecifiedSalutation()->getId(),
+            'salutationId'             => $this->helper->Salutation()->getNotSpecifiedSalutation()->getId(),
             'customerNumber'           => '1122',
             'firstName'                => 'John',
             'lastName'                 => 'Doe',

diff --git a/src/FixtureHelper.php b/src/FixtureHelper.php
@@ -6,11 +6,11 @@
 
 use Basecom\FixturePlugin\Utils\CategoryUtils;
 use Basecom\FixturePlugin\Utils\CmsUtils;
-use Basecom\FixturePlugin\Utils\CustomerUtils;
 use Basecom\FixturePlugin\Utils\DatabaseUtils;
 use Basecom\FixturePlugin\Utils\MediaUtils;
 use Basecom\FixturePlugin\Utils\PaymentMethodUtils;
 use Basecom\FixturePlugin\Utils\SalesChannelUtils;
+use Basecom\FixturePlugin\Utils\SalutationUtils;
 use Basecom\FixturePlugin\Utils\ShippingMethodUtils;
 
 readonly class FixtureHelper
@@ -22,7 +22,7 @@ public function __construct(
         private CmsUtils $cmsUtils,
         private PaymentMethodUtils $paymentMethodUtils,
         private ShippingMethodUtils $shippingMethodUtils,
-        private CustomerUtils $customerUtils,
+        private SalutationUtils $salutationUtils,
         private DatabaseUtils $databaseUtils,
     ) {
     }
@@ -55,12 +55,12 @@ public function SalesChannel(): SalesChannelUtils
     }
 
     /**
-     * Use this to access the customer related features
+     * Use this to access the salutation related features
      * of the fixture helper class.
      */
-    public function Customer(): CustomerUtils
+    public function Salutation(): SalutationUtils
     {
-        return $this->customerUtils;
+        return $this->salutationUtils;
     }
 
     /**

diff --git a/src/Utils/CategoryUtils.php b/src/Utils/CategoryUtils.php
@@ -35,7 +35,7 @@ public function __construct(
      */
     public function getRootCategory(): ?CategoryEntity
     {
-        return once(function () {
+        return once(function (): ?CategoryEntity {
             $criteria = (new Criteria())
                 ->addFilter(new EqualsFilter('autoIncrement', 1))
                 ->addFilter(new EqualsFilter('level', 1))

diff --git a/src/Utils/CmsUtils.php b/src/Utils/CmsUtils.php
@@ -12,6 +12,15 @@
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
 
+/**
+ * This class provides utility methods to work with the shopware cms. It has build in caching to prevent
+ * multiple database queries for the same data within one command execution / request.
+ *
+ * This class is designed to be used through the FixtureHelper, using:
+ * ```php
+ * $this->helper->Cms()->……();
+ * ```
+ */
 readonly class CmsUtils
 {
     /**
@@ -24,15 +33,19 @@ public function __construct(
 
     public function getDefaultCategoryLayout(): ?CmsPageEntity
     {
-        $criteria = (new Criteria())
-            ->addFilter(new EqualsFilter('locked', '1'))
-            ->addFilter(new EqualsAnyFilter('translations.name', ['Default category layout', 'Default listing layout']))
-            ->setLimit(1);
+        return once(function (): ?CmsPageEntity {
+            $criteria = (new Criteria())
+                ->addFilter(new EqualsFilter('locked', '1'))
+                ->addFilter(new EqualsAnyFilter('translations.name', ['Default category layout', 'Default listing layout']))
+                ->setLimit(1);
 
-        $cmsPage = $this->cmsPageRepository
-            ->search($criteria, Context::createDefaultContext())
-            ->first();
+            $criteria->setTitle(sprintf('%s::%s()', __CLASS__, __FUNCTION__));
 
-        return $cmsPage instanceof CmsPageEntity ? $cmsPage : null;
+            $cmsPage = $this->cmsPageRepository
+                ->search($criteria, Context::createDefaultContext())
+                ->first();
+
+            return $cmsPage instanceof CmsPageEntity ? $cmsPage : null;
+        });
     }
 }
diff --git a/src/Utils/CustomerUtils.php b/src/Utils/CustomerUtils.php
diff --git a/src/Utils/DatabaseUtils.php b/src/Utils/DatabaseUtils.php
@@ -8,6 +8,16 @@
 use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 
+/**
+ * This class provides utility methods to directly interact with the database. It has build in
+ * caching to prevent multiple database queries for the same data within one command
+ * execution / request.
+ *
+ * This class is designed to be used through the FixtureHelper, using:
+ * ```php
+ * $this->helper->Database()->……();
+ * ```
+ */
 readonly class DatabaseUtils
 {
     public function __construct(

diff --git a/src/Utils/MediaUtils.php b/src/Utils/MediaUtils.php
@@ -14,6 +14,15 @@
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
 
+/**
+ * This class provides utility methods to work with media assets. It has build in caching to prevent
+ * multiple database queries for the same data within one command execution / request.
+ *
+ * This class is designed to be used through the FixtureHelper, using:
+ * ```php
+ * $this->helper->Media()->……();
+ * ```
+ */
 readonly class MediaUtils
 {
     /**
@@ -30,31 +39,41 @@ public function __construct(
 
     /**
      * Copied from "vendor/shopware/core/Content/Media/MediaService.php".
+     *
+     * Extended it to include simple cache
      */
     public function getDefaultFolder(string $folderName): ?MediaFolderEntity
     {
-        $criteria = (new Criteria())
-            ->addFilter(new EqualsFilter('media_folder.defaultFolder.entity', $folderName))
-            ->addAssociation('defaultFolder')
-            ->setLimit(1);
+        return once(function () use ($folderName): ?MediaFolderEntity {
+            $criteria = (new Criteria())
+                ->addFilter(new EqualsFilter('media_folder.defaultFolder.entity', $folderName))
+                ->addAssociation('defaultFolder')
+                ->setLimit(1);
 
-        $mediaFolder = $this->mediaFolderRepository
-            ->search($criteria, Context::createDefaultContext())
-            ->first();
+            $criteria->setTitle(sprintf('%s::%s()', __CLASS__, __FUNCTION__));
 
-        return $mediaFolder instanceof MediaFolderEntity ? $mediaFolder : null;
+            $mediaFolder = $this->mediaFolderRepository
+                ->search($criteria, Context::createDefaultContext())
+                ->first();
+
+            return $mediaFolder instanceof MediaFolderEntity ? $mediaFolder : null;
+        });
     }
 
+    /**
+     * "Upload" a file within shopware. It takes a real file path ($filename) and uploads it as a full media.
+     */
     public function upload(string $mediaId, string $folderId, string $filename, string $extension, string $contentType): void
     {
         $ctx = Context::createDefaultContext();
 
-        $this->mediaRepository->upsert([
+        $this->mediaRepository->upsert(
             [
-                'id'            => $mediaId,
-                'mediaFolderId' => $folderId,
+                [
+                    'id'            => $mediaId,
+                    'mediaFolderId' => $folderId,
+                ],
             ],
-        ],
             $ctx,
         );
 

diff --git a/src/Utils/PaymentMethodUtils.php b/src/Utils/PaymentMethodUtils.php
@@ -12,6 +12,15 @@
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
 
+/**
+ * This class provides utility methods to work with payment methods. It has build in caching to prevent
+ * multiple database queries for the same data within one command execution / request.
+ *
+ * This class is designed to be used through the FixtureHelper, using:
+ * ```php
+ * $this->helper->PaymentMethod()->……();
+ * ```
+ */
 readonly class PaymentMethodUtils
 {
     /**
@@ -22,16 +31,23 @@ public function __construct(
     ) {
     }
 
+    /**
+     * Return the default invoice payment method of shopware.
+     */
     public function getInvoicePaymentMethod(): ?PaymentMethodEntity
     {
-        $criteria = (new Criteria())->addFilter(
-            new EqualsFilter('handlerIdentifier', InvoicePayment::class),
-        )->setLimit(1);
+        return once(function (): ?PaymentMethodEntity {
+            $criteria = (new Criteria())->addFilter(
+                new EqualsFilter('handlerIdentifier', InvoicePayment::class),
+            )->setLimit(1);
+
+            $criteria->setTitle(sprintf('%s::%s()', __CLASS__, __FUNCTION__));
 
-        $paymentMethod = $this->paymentMethodRepository
-            ->search($criteria, Context::createDefaultContext())
-            ->first();
+            $paymentMethod = $this->paymentMethodRepository
+                ->search($criteria, Context::createDefaultContext())
+                ->first();
 
-        return $paymentMethod instanceof PaymentMethodEntity ? $paymentMethod : null;
+            return $paymentMethod instanceof PaymentMethodEntity ? $paymentMethod : null;
+        });
     }
 }