Merge pull request #1411 from dpfaffenbauer/3.0-features/remove-item-…

…key-transformer-service

[All] remove usage of ItemKeyTransformer Service and use DataObject\Service directly

src/CoreShop/Bundle/CoreBundle/Resources/config/services/order.yml

@@ -109,7 +109,6 @@ services:
             - '@CoreShop\Component\Pimcore\DataObject\ObjectServiceInterface'
             - '@coreshop.order.number_generator.default'
             - '@CoreShop\Component\Pimcore\DataObject\ObjectClonerInterface'
-            - '@CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface'
             - '@CoreShop\Bundle\WorkflowBundle\Applier\StateMachineApplier'
             - '%coreshop.folder.order%'
 
@@ -120,5 +119,4 @@ services:
             - '@CoreShop\Component\Pimcore\DataObject\ObjectServiceInterface'
             - '@coreshop.quote.number_generator.default'
             - '@CoreShop\Component\Pimcore\DataObject\ObjectClonerInterface'
-            - '@CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface'
             - '%coreshop.folder.quote%'

src/CoreShop/Bundle/OrderBundle/Resources/config/services/order_invoice.yml

@@ -17,7 +17,6 @@ services:
     CoreShop\Component\Order\Transformer\OrderToInvoiceTransformer:
         arguments:
             - '@CoreShop\Component\Order\Transformer\OrderItemToInvoiceItemTransformer'
-            - '@CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface'
             - '@coreshop.order_invoice.number_generator.default'
             - '%coreshop.folder.order_invoice%'
             - '@CoreShop\Component\Pimcore\DataObject\ObjectServiceInterface'

src/CoreShop/Bundle/OrderBundle/Resources/config/services/order_shipment.yml

@@ -17,7 +17,6 @@ services:
     CoreShop\Component\Order\Transformer\OrderToShipmentTransformer:
         arguments:
             - '@CoreShop\Component\Order\Transformer\OrderItemToShipmentItemTransformer'
-            - '@CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface'
             - '@coreshop.order_shipment.number_generator.default'
             - '%coreshop.folder.order_shipment%'
             - '@CoreShop\Component\Pimcore\DataObject\ObjectServiceInterface'

src/CoreShop/Component/Core/Order/Committer/OrderCommitter.php

@@ -31,8 +31,8 @@
 use CoreShop\Component\Pimcore\DataObject\ObjectClonerInterface;
 use CoreShop\Component\Pimcore\DataObject\ObjectServiceInterface;
 use CoreShop\Component\Pimcore\DataObject\VersionHelper;
-use CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface;
 use Pimcore\Model\DataObject\Folder;
+use Pimcore\Model\DataObject\Service;
 use Webmozart\Assert\Assert;
 
 class OrderCommitter implements OrderCommitterInterface, QuoteCommitterInterface
@@ -57,11 +57,6 @@ class OrderCommitter implements OrderCommitterInterface, QuoteCommitterInterface
      */
     protected $objectCloner;
 
-    /**
-     * @var ItemKeyTransformerInterface
-     */
-    protected $keyTransformer;
-
     /**
      * @var StateMachineApplierInterface
      */
@@ -77,15 +72,13 @@ public function __construct(
         ObjectServiceInterface $objectService,
         NumberGeneratorInterface $numberGenerator,
         ObjectClonerInterface $objectCloner,
-        ItemKeyTransformerInterface $keyTransformer,
         StateMachineApplierInterface $stateMachineApplier,
         string $orderFolderPath
     ) {
         $this->cartManager = $cartManager;
         $this->objectService = $objectService;
         $this->numberGenerator = $numberGenerator;
         $this->objectCloner = $objectCloner;
-        $this->keyTransformer = $keyTransformer;
         $this->stateMachineApplier = $stateMachineApplier;
         $this->orderFolderPath = $orderFolderPath;
     }
@@ -110,7 +103,7 @@ public function commitOrder(OrderInterface $order): void
         $order->setSaleState(OrderSaleStates::STATE_ORDER);
         $order->setOrderDate(Carbon::now());
         $order->setOrderNumber($orderNumber);
-        $order->setKey($this->keyTransformer->transform($orderNumber));
+        $order->setKey(Service::getValidKey($orderNumber, 'object'));
         $order->setOrderState(OrderStates::STATE_INITIALIZED);
         $order->setShippingState(OrderShipmentStates::STATE_NEW);
         $order->setPaymentState(OrderPaymentStates::STATE_NEW);

src/CoreShop/Component/Core/Order/Committer/QuoteCommitter.php

@@ -15,24 +15,17 @@
 namespace CoreShop\Component\Core\Order\Committer;
 
 use Carbon\Carbon;
-use CoreShop\Bundle\WorkflowBundle\Applier\StateMachineApplierInterface;
 use CoreShop\Component\Address\Model\AddressInterface;
 use CoreShop\Component\Order\Committer\OrderCommitterInterface;
 use CoreShop\Component\Order\Committer\QuoteCommitterInterface;
 use CoreShop\Component\Order\Manager\CartManagerInterface;
 use CoreShop\Component\Order\Model\OrderInterface;
 use CoreShop\Component\Order\NumberGenerator\NumberGeneratorInterface;
-use CoreShop\Component\Order\OrderInvoiceStates;
-use CoreShop\Component\Order\OrderPaymentStates;
 use CoreShop\Component\Order\OrderSaleStates;
-use CoreShop\Component\Order\OrderShipmentStates;
-use CoreShop\Component\Order\OrderStates;
-use CoreShop\Component\Order\OrderTransitions;
 use CoreShop\Component\Pimcore\DataObject\ObjectClonerInterface;
 use CoreShop\Component\Pimcore\DataObject\ObjectServiceInterface;
 use CoreShop\Component\Pimcore\DataObject\VersionHelper;
-use CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface;
-use Pimcore\Model\DataObject\Folder;
+use Pimcore\Model\DataObject\Service;
 use Webmozart\Assert\Assert;
 
 class QuoteCommitter implements OrderCommitterInterface, QuoteCommitterInterface
@@ -57,10 +50,6 @@ class QuoteCommitter implements OrderCommitterInterface, QuoteCommitterInterface
      */
     protected $objectCloner;
 
-    /**
-     * @var ItemKeyTransformerInterface
-     */
-    protected $keyTransformer;
 
     /**
      * @var string
@@ -72,14 +61,12 @@ public function __construct(
         ObjectServiceInterface $objectService,
         NumberGeneratorInterface $numberGenerator,
         ObjectClonerInterface $objectCloner,
-        ItemKeyTransformerInterface $keyTransformer,
         string $orderFolderPath
     ) {
         $this->cartManager = $cartManager;
         $this->objectService = $objectService;
         $this->numberGenerator = $numberGenerator;
         $this->objectCloner = $objectCloner;
-        $this->keyTransformer = $keyTransformer;
         $this->orderFolderPath = $orderFolderPath;
     }
 
@@ -103,7 +90,7 @@ public function commitOrder(OrderInterface $order): void
         $order->setSaleState(OrderSaleStates::STATE_QUOTE);
         $order->setOrderDate(Carbon::now());
         $order->setOrderNumber($orderNumber);
-        $order->setKey($this->keyTransformer->transform($orderNumber));
+        $order->setKey(Service::getValidKey($orderNumber, 'object'));
 
         $this->cartManager->persistCart($order);
 

src/CoreShop/Component/Order/Transformer/OrderToInvoiceTransformer.php

@@ -28,76 +28,23 @@
 use CoreShop\Component\Pimcore\DataObject\VersionHelper;
 use CoreShop\Component\Resource\Factory\PimcoreFactoryInterface;
 use CoreShop\Component\Resource\Repository\PimcoreRepositoryInterface;
-use CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface;
+use Pimcore\Model\DataObject\Service;
 use Webmozart\Assert\Assert;
 
 class OrderToInvoiceTransformer implements OrderDocumentTransformerInterface
 {
-    /**
-     * @var OrderDocumentItemTransformerInterface
-     */
     protected $orderItemToInvoiceItemTransformer;
-
-    /**
-     * @var ItemKeyTransformerInterface
-     */
-    protected $keyTransformer;
-
-    /**
-     * @var NumberGeneratorInterface
-     */
     protected $numberGenerator;
-
-    /**
-     * @var string
-     */
     protected $invoiceFolderPath;
-
-    /**
-     * @var ObjectServiceInterface
-     */
     protected $objectService;
-
-    /**
-     * @var PimcoreRepositoryInterface
-     */
     protected $orderItemRepository;
-
-    /**
-     * @var PimcoreFactoryInterface
-     */
     protected $invoiceItemFactory;
-
-    /**
-     * @var OrderInvoiceRepositoryInterface
-     */
     protected $invoiceRepository;
-
-    /**
-     * @var TransformerEventDispatcherInterface
-     */
     protected $eventDispatcher;
-
-    /**
-     * @var AdjustmentFactoryInterface
-     */
     protected $adjustmentFactory;
 
-    /**
-     * @param OrderDocumentItemTransformerInterface $orderDocumentItemTransformer
-     * @param ItemKeyTransformerInterface           $keyTransformer
-     * @param NumberGeneratorInterface              $numberGenerator
-     * @param string                                $invoiceFolderPath
-     * @param ObjectServiceInterface                $objectService
-     * @param PimcoreRepositoryInterface            $orderItemRepository
-     * @param PimcoreFactoryInterface               $invoiceItemFactory
-     * @param OrderInvoiceRepositoryInterface       $invoiceRepository
-     * @param TransformerEventDispatcherInterface   $eventDispatcher
-     * @param AdjustmentFactoryInterface            $adjustmentFactory
-     */
     public function __construct(
         OrderDocumentItemTransformerInterface $orderDocumentItemTransformer,
-        ItemKeyTransformerInterface $keyTransformer,
         NumberGeneratorInterface $numberGenerator,
         $invoiceFolderPath,
         ObjectServiceInterface $objectService,
@@ -108,7 +55,6 @@ public function __construct(
         AdjustmentFactoryInterface $adjustmentFactory
     ) {
         $this->orderItemToInvoiceItemTransformer = $orderDocumentItemTransformer;
-        $this->keyTransformer = $keyTransformer;
         $this->numberGenerator = $numberGenerator;
         $this->invoiceFolderPath = $invoiceFolderPath;
         $this->objectService = $objectService;
@@ -141,7 +87,7 @@ public function transform(OrderInterface $order, OrderDocumentInterface $invoice
         /**
          * @var OrderInvoiceInterface $invoice
          */
-        $invoice->setKey($this->keyTransformer->transform($invoiceNumber));
+        $invoice->setKey(Service::getValidKey($invoiceNumber, 'object'));
         $invoice->setInvoiceNumber($invoiceNumber);
         $invoice->setParent($invoiceFolder);
         $invoice->setPublished(true);

src/CoreShop/Component/Order/Transformer/OrderToShipmentTransformer.php

@@ -24,73 +24,29 @@
 use CoreShop\Component\Pimcore\DataObject\VersionHelper;
 use CoreShop\Component\Resource\Factory\PimcoreFactoryInterface;
 use CoreShop\Component\Resource\Repository\PimcoreRepositoryInterface;
-use CoreShop\Component\Resource\Transformer\ItemKeyTransformerInterface;
+use Pimcore\Model\DataObject\Service;
 use Webmozart\Assert\Assert;
 
 class OrderToShipmentTransformer implements OrderDocumentTransformerInterface
 {
-    /**
-     * @var OrderDocumentItemTransformerInterface
-     */
     protected $orderItemToShipmentItemTransformer;
-
-    /**
-     * @var ItemKeyTransformerInterface
-     */
-    protected $keyTransformer;
-
-    /**
-     * @var NumberGeneratorInterface
-     */
     protected $numberGenerator;
-
-    /**
-     * @var string
-     */
     protected $shipmentFolderPath;
-
-    /**
-     * @var ObjectServiceInterface
-     */
     protected $objectService;
-
-    /**
-     * @var PimcoreRepositoryInterface
-     */
     protected $orderItemRepository;
-
-    /**
-     * @var PimcoreFactoryInterface
-     */
     protected $shipmentItemFactory;
-
-    /**
-     * @var TransformerEventDispatcherInterface
-     */
     protected $eventDispatcher;
 
-    /**
-     * @param OrderDocumentItemTransformerInterface $orderItemToShipmentItemTransformer
-     * @param ItemKeyTransformerInterface           $keyTransformer
-     * @param NumberGeneratorInterface              $numberGenerator
-     * @param string                                $shipmentFolderPath
-     * @param ObjectServiceInterface                $objectService
-     * @param PimcoreRepositoryInterface            $orderItemRepository
-     * @param PimcoreFactoryInterface               $shipmentItemFactory
-     * @param TransformerEventDispatcherInterface   $eventDispatcher
-     */
     public function __construct(
         OrderDocumentItemTransformerInterface $orderItemToShipmentItemTransformer,
-        ItemKeyTransformerInterface $keyTransformer,
         NumberGeneratorInterface $numberGenerator,
-        $shipmentFolderPath,
+        string $shipmentFolderPath,
         ObjectServiceInterface $objectService,
         PimcoreRepositoryInterface $orderItemRepository,
         PimcoreFactoryInterface $shipmentItemFactory,
         TransformerEventDispatcherInterface $eventDispatcher
     ) {
         $this->orderItemToShipmentItemTransformer = $orderItemToShipmentItemTransformer;
-        $this->keyTransformer = $keyTransformer;
         $this->numberGenerator = $numberGenerator;
         $this->shipmentFolderPath = $shipmentFolderPath;
         $this->objectService = $objectService;
@@ -122,7 +78,7 @@ public function transform(OrderInterface $order, OrderDocumentInterface $shipmen
          * @var $shipment OrderShipmentInterface
          * @var $order    OrderInterface
          */
-        $shipment->setKey($this->keyTransformer->transform($shipmentNumber));
+        $shipment->setKey(Service::getValidKey($shipmentNumber, 'object'));
         $shipment->setShipmentNumber($shipmentNumber);
         $shipment->setParent($shipmentFolder);
         $shipment->setPublished(true);