graphQl-200: Product Compare

app/code/Magento/Catalog/Model/CompareList.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model;
+
+use Magento\Framework\Model\AbstractModel;
+
+/**
+ * @method string getHashedId()
+ * @method CompareList setHashedId()
+ * @method int getCustomerId()
+ * @method CompareList setCustomerId()
+ */
+class CompareList extends AbstractModel
+{
+    /**
+     * Initialize resource
+     *
+     * @return void
+     */
+    protected function _construct()
+    {
+        $this->_init(\Magento\Catalog\Model\ResourceModel\CompareList::class);
+    }
+}

app/code/Magento/Catalog/Model/CompareList/CustomerIdByHashedIdProvider.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\CompareList;
+
+use Magento\Catalog\Model\CompareListFactory;
+use Magento\Catalog\Model\ResourceModel\CompareList as ResourceCompareList;
+
+/**
+ * @inheritdoc
+ */
+class CustomerIdByHashedIdProvider implements CustomerIdByHashedIdProviderInterface
+{
+    /**
+     * @var CompareListFactory
+     */
+    private $compareListFactory;
+
+    /**
+     * @var ResourceCompareList
+     */
+    private $resourceCompareList;
+
+    /**
+     * @param CompareListFactory $compareListFactory
+     * @param ResourceCompareList $resourceCompareList
+     */
+    public function __construct(
+        CompareListFactory $compareListFactory,
+        ResourceCompareList $resourceCompareList
+    ) {
+        $this->compareListFactory = $compareListFactory;
+        $this->resourceCompareList = $resourceCompareList;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get(string $hashedListId): int
+    {
+        $compareList = $this->compareListFactory->create();
+        $this->resourceCompareList->load($compareList, $hashedListId, 'hashed_id');
+
+        return (int)$compareList->getCustomerId();
+    }
+}

app/code/Magento/Catalog/Model/CompareList/CustomerIdByHashedIdProviderInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\CompareList;
+
+/**
+ * Get customer id by hashed id.
+ * @api
+ */
+interface CustomerIdByHashedIdProviderInterface
+{
+    /**
+     * @param string $hashedListId
+     *
+     * @return int
+     */
+    public function get(string $hashedListId): int;
+}

app/code/Magento/Catalog/Model/CompareList/HashedListIdToListId.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\CompareList;
+
+use Magento\Catalog\Model\CompareListFactory;
+use Magento\Catalog\Model\ResourceModel\CompareList as ResourceCompareList;
+
+/**
+ * @inheritdoc
+ */
+class HashedListIdToListId implements HashedListIdToListIdInterface
+{
+    /**
+     * @var CompareListFactory
+     */
+    private $compareListFactory;
+
+    /**
+     * @var ResourceCompareList
+     */
+    private $resourceCompareList;
+
+    /**
+     * @param CompareListFactory $compareListFactory
+     * @param ResourceCompareList $resourceCompareList
+     */
+    public function __construct(
+        CompareListFactory $compareListFactory,
+        ResourceCompareList $resourceCompareList
+    ) {
+        $this->compareListFactory = $compareListFactory;
+        $this->resourceCompareList = $resourceCompareList;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function execute(string $hashedListId): int
+    {
+        $compareList = $this->compareListFactory->create();
+        $this->resourceCompareList->load($compareList, $hashedListId, 'hashed_id');
+
+        return (int)$compareList->getListId();
+    }
+}

app/code/Magento/Catalog/Model/CompareList/HashedListIdToListIdInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\CompareList;
+
+/**
+ * Converts hashed list id to the list id.
+ * @api
+ */
+interface HashedListIdToListIdInterface
+{
+    /**
+     * @param string $hashedListId
+     *
+     * @return int
+     */
+    public function execute(string $hashedListId): int;
+}

app/code/Magento/Catalog/Model/CompareList/ListIdToHashedListId.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\CompareList;
+
+use Magento\Catalog\Model\CompareListFactory;
+use Magento\Catalog\Model\ResourceModel\CompareList as ResourceCompareList;
+
+/**
+ * @inheritdoc
+ */
+class ListIdToHashedListId implements ListIdToHashedListIdInterface
+{
+    /**
+     * @var CompareListFactory
+     */
+    private $compareListFactory;
+
+    /**
+     * @var ResourceCompareList
+     */
+    private $resourceCompareList;
+
+    /**
+     * @param CompareListFactory $compareListFactory
+     * @param ResourceCompareList $resourceCompareList
+     */
+    public function __construct(
+        CompareListFactory $compareListFactory,
+        ResourceCompareList $resourceCompareList
+    ) {
+        $this->compareListFactory = $compareListFactory;
+        $this->resourceCompareList = $resourceCompareList;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function execute(int $listId): string
+    {
+        $compareList = $this->compareListFactory->create();
+        $this->resourceCompareList->load($compareList, $listId, 'list_id');
+
+        return $compareList->getListId();
+    }
+}

app/code/Magento/Catalog/Model/CompareList/ListIdToHashedListIdInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\CompareList;
+
+/**
+ * Converts list id to the list hashed id.
+ * @api
+ */
+interface ListIdToHashedListIdInterface
+{
+    /**
+     * @param int $listId
+     *
+     * @return string
+     */
+    public function execute(int $listId): string;
+}

app/code/Magento/Catalog/Model/Product/Compare/AddToList.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model\Product\Compare;
+
+use Magento\Catalog\Model\CompareList\CustomerIdByHashedIdProviderInterface;
+use Magento\Catalog\Model\CompareList\HashedListIdToListIdInterface;
+
+class AddToList
+{
+    /**
+     * @var ItemFactory
+     */
+    private $compareItemFactory;
+
+    /**
+     * @var HashedListIdToListIdInterface
+     */
+    private $hashedListIdToListId;
+
+    /**
+     * @var CustomerIdByHashedIdProviderInterface
+     */
+    private $customerIdByHashedIdProvider;
+
+    /**
+     * @param ItemFactory $compareItemFactory
+     * @param HashedListIdToListIdInterface $hashedListIdToListId
+     * @param CustomerIdByHashedIdProviderInterface $customerIdByHashedIdProvider
+     */
+    public function __construct(
+        ItemFactory $compareItemFactory,
+        HashedListIdToListIdInterface $hashedListIdToListId,
+        CustomerIdByHashedIdProviderInterface $customerIdByHashedIdProvider
+    ) {
+        $this->compareItemFactory = $compareItemFactory;
+        $this->hashedListIdToListId = $hashedListIdToListId;
+        $this->customerIdByHashedIdProvider = $customerIdByHashedIdProvider;
+    }
+
+    /**
+     * @param int $customerId
+     * @param string $hashedId
+     * @param int $productId
+     */
+    public function execute(int $customerId, string $hashedId, int $productId)
+    {
+        $item = $this->compareItemFactory->create();
+        if (0 !== $customerId) {
+            $item->setCustomerId($customerId);
+        }
+
+        $listId = $this->hashedListIdToListId->execute($hashedId);
+        $listCustomerId = $this->customerIdByHashedIdProvider->get($hashedId);
+
+        $item->setCatalogCompareListId($listId);
+        $item->loadByProduct($productId);
+
+        if (!$item->getId() && $customerId === $listCustomerId) {
+            $item->addProductData($productId);
+            $item->save();
+        }
+    }
+}

app/code/Magento/Catalog/Model/Product/Compare/CreateList.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model\Product\Compare;
+
+use Magento\Catalog\Model\CompareListFactory;
+use Magento\Framework\Math\Random;
+
+/**
+ * Create new compare list.
+ */
+class CreateList
+{
+    /**
+     * @var CompareListFactory
+     */
+    private $compareListFactory;
+
+    /**
+     * @var Random
+     */
+    private $randomDataGenerator;
+
+    /**
+     * @param CompareListFactory $compareListFactory
+     * @param Random $randomDataGenerator
+     */
+    public function __construct(
+        CompareListFactory $compareListFactory,
+        Random $randomDataGenerator
+    ) {
+        $this->compareListFactory = $compareListFactory;
+        $this->randomDataGenerator = $randomDataGenerator;
+    }
+
+    /**
+     * If customerId === 0 list will be created for guest.
+     *
+     * @param int $customerId
+     */
+    public function execute(int $customerId)
+    {
+        $compareList = $this->compareListFactory->create();
+
+        if (0 !== $customerId) {
+            $compareList->setCustomerId($customerId);
+        }
+
+        $compareList->setHashedId($this->randomDataGenerator->getUniqueHash())->save();
+
+        return $compareList;
+    }
+}

app/code/Magento/Catalog/Model/Product/Compare/Item.php

@@ -12,6 +12,8 @@
  *
  * @api
  * @method \Magento\Catalog\Model\Product\Compare\Item setVisitorId(int $value)
+ * @method int getCatalogCompareListId()
+ * @method \Magento\Catalog\Model\Product\Compare\Item setCatalogCompareListId(int $value)
  * @method \Magento\Catalog\Model\Product\Compare\Item setCustomerId(int $value)
  * @method int getProductId()
  * @method \Magento\Catalog\Model\Product\Compare\Item setProductId(int $value)