feat(Store): support Store model

Author: nikossvnk

src/Core/Builder/Request/RequestBuilder.php

@@ -215,6 +215,14 @@ public function states()
         return new StateRequestBuilder();
     }
 
+    /**
+     * @return StoreRequestBuilder
+     */
+    public function stores()
+    {
+        return new StoreRequestBuilder();
+    }
+
     /**
      * @return SubscriptionRequestBuilder
      */

src/Core/Builder/Request/StoreRequestBuilder.php

@@ -0,0 +1,114 @@
+<?php
+// phpcs:disable Generic.Files.LineLength
+namespace Commercetools\Core\Builder\Request;
+
+use Commercetools\Core\Request\Stores\StoreByIdGetRequest;
+use Commercetools\Core\Request\Stores\StoreByKeyGetRequest;
+use Commercetools\Core\Request\Stores\StoreCreateRequest;
+use Commercetools\Core\Model\Store\StoreDraft;
+use Commercetools\Core\Request\Stores\StoreDeleteByKeyRequest;
+use Commercetools\Core\Model\Store\Store;
+use Commercetools\Core\Request\Stores\StoreDeleteRequest;
+use Commercetools\Core\Request\Stores\StoreQueryRequest;
+use Commercetools\Core\Request\Stores\StoreUpdateByKeyRequest;
+use Commercetools\Core\Request\Stores\StoreUpdateRequest;
+
+class StoreRequestBuilder
+{
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#get-a-store-by-id
+     * @param string $id
+     * @return StoreByIdGetRequest
+     */
+    public function getById($id)
+    {
+        $request = StoreByIdGetRequest::ofId($id);
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#get-a-store-by-key
+     * @param string $key
+     * @return StoreByKeyGetRequest
+     */
+    public function getByKey($key)
+    {
+        $request = StoreByKeyGetRequest::ofKey($key);
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#create-a-store
+     * @param StoreDraft $store
+     * @return StoreCreateRequest
+     */
+    public function create(StoreDraft $store)
+    {
+        $request = StoreCreateRequest::ofDraft($store);
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#delete-store-by-key
+     * @param Store $store
+     * @return StoreDeleteByKeyRequest
+     */
+    public function deleteByKey(Store $store)
+    {
+        $request = StoreDeleteByKeyRequest::ofKeyAndVersion($store->getKey(), $store->getVersion());
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#delete-store-by-id
+     * @param Store $store
+     * @return StoreDeleteRequest
+     */
+    public function delete(Store $store)
+    {
+        $request = StoreDeleteRequest::ofIdAndVersion($store->getId(), $store->getVersion());
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#query-stores
+     *
+     * @return StoreQueryRequest
+     */
+    public function query()
+    {
+        $request = StoreQueryRequest::of();
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#update-store-by-key
+     * @param Store $store
+     * @return StoreUpdateByKeyRequest
+     */
+    public function updateByKey(Store $store)
+    {
+        $request = StoreUpdateByKeyRequest::ofKeyAndVersion($store->getKey(), $store->getVersion());
+        return $request;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#update-store-by-id
+     * @param Store $store
+     * @return StoreUpdateRequest
+     */
+    public function update(Store $store)
+    {
+        $request = StoreUpdateRequest::ofIdAndVersion($store->getId(), $store->getVersion());
+        return $request;
+    }
+
+    /**
+     * @return StoreRequestBuilder
+     */
+    public function of()
+    {
+        return new self();
+    }
+}

src/Core/Builder/Update/ActionBuilder.php

@@ -180,6 +180,14 @@ public function states()
         return new StatesActionBuilder();
     }
 
+    /**
+     * @return StoresActionBuilder
+     */
+    public function stores()
+    {
+        return new StoresActionBuilder();
+    }
+
     /**
      * @return SubscriptionsActionBuilder
      */

src/Core/Builder/Update/StoresActionBuilder.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace Commercetools\Core\Builder\Update;
+
+use Commercetools\Core\Error\InvalidArgumentException;
+use Commercetools\Core\Request\AbstractAction;
+use Commercetools\Core\Request\Stores\Command\StoreSetNameAction;
+
+class StoresActionBuilder
+{
+    private $actions = [];
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-stores#set-name
+     * @param StoreSetNameAction|callable $action
+     * @return $this
+     */
+    public function setName($action = null)
+    {
+        $this->addAction($this->resolveAction(StoreSetNameAction::class, $action));
+        return $this;
+    }
+
+    /**
+     * @return StoresActionBuilder
+     */
+    public static function of()
+    {
+        return new self();
+    }
+
+    /**
+     * @param $class
+     * @param $action
+     * @return AbstractAction
+     * @throws InvalidArgumentException
+     */
+    private function resolveAction($class, $action = null)
+    {
+        if (is_null($action) || is_callable($action)) {
+            $callback = $action;
+            $emptyAction = $class::of();
+            $action = $this->callback($emptyAction, $callback);
+        }
+        if ($action instanceof $class) {
+            return $action;
+        }
+        throw new InvalidArgumentException(
+            sprintf('Expected method to be called with or callable to return %s', $class)
+        );
+    }
+
+    /**
+     * @param $action
+     * @param callable $callback
+     * @return AbstractAction
+     */
+    private function callback($action, callable $callback = null)
+    {
+        if (!is_null($callback)) {
+            $action = $callback($action);
+        }
+        return $action;
+    }
+
+    /**
+     * @param AbstractAction $action
+     * @return $this;
+     */
+    public function addAction(AbstractAction $action)
+    {
+        $this->actions[] = $action;
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getActions()
+    {
+        return $this->actions;
+    }
+
+
+    /**
+     * @param array $actions
+     * @return $this
+     */
+    public function setActions(array $actions)
+    {
+        $this->actions = $actions;
+        return $this;
+    }
+}

src/Core/Model/Cart/Cart.php

@@ -16,6 +16,7 @@
 use Commercetools\Core\Model\CustomField\CustomFieldObject;
 use Commercetools\Core\Model\Common\DateTimeDecorator;
 use Commercetools\Core\Model\Payment\PaymentInfo;
+use Commercetools\Core\Model\Store\StoreReference;
 use DateTime;
 
 /**
@@ -80,6 +81,8 @@
  * @method Cart setShippingRateInput(ShippingRateInput $shippingRateInput = null)
  * @method AddressCollection getItemShippingAddresses()
  * @method Cart setItemShippingAddresses(AddressCollection $itemShippingAddresses = null)
+ * @method StoreReference getStore()
+ * @method Cart setStore(StoreReference $store = null)
  * @method CartReference getReference()
  */
 class Cart extends Resource
@@ -139,6 +142,7 @@ public function fieldDefinitions()
             'taxCalculationMode' => [static::TYPE => 'string'],
             'shippingRateInput' => [static::TYPE => ShippingRateInput::class],
             'itemShippingAddresses' => [static::TYPE => AddressCollection::class],
+            'store' => [static::TYPE => StoreReference::class],
         ];
     }
 

src/Core/Model/Cart/CartDraft.php

@@ -13,6 +13,7 @@
 use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
 use Commercetools\Core\Model\Common\Address;
 use Commercetools\Core\Model\ShippingMethod\ShippingMethodReference;
+use Commercetools\Core\Model\Store\StoreReference;
 use Commercetools\Core\Model\TaxCategory\ExternalTaxRateDraft;
 
 /**
@@ -61,6 +62,8 @@
  * @method CartDraft setShippingRateInput(ShippingRateInputDraft $shippingRateInput = null)
  * @method AddressCollection getItemShippingAddresses()
  * @method CartDraft setItemShippingAddresses(AddressCollection $itemShippingAddresses = null)
+ * @method StoreReference getStore()
+ * @method CartDraft setStore(StoreReference $store = null)
  */
 class CartDraft extends JsonObject
 {
@@ -91,6 +94,7 @@ public function fieldDefinitions()
             'externalTaxRateForShippingMethod' => [static::TYPE => ExternalTaxRateDraft::class],
             'shippingRateInput' => [static::TYPE => ShippingRateInputDraft::class],
             'itemShippingAddresses' => [static::TYPE => AddressCollection::class],
+            'store' => [static::TYPE => StoreReference::class],
         ];
     }
 

src/Core/Model/Common/KeyReference.php

@@ -0,0 +1,89 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Model\Common;
+
+use Commercetools\Core\Model\Cart\CartReference;
+use Commercetools\Core\Model\CartDiscount\CartDiscountReference;
+use Commercetools\Core\Model\Category\CategoryReference;
+use Commercetools\Core\Model\Channel\ChannelReference;
+use Commercetools\Core\Model\Customer\CustomerReference;
+use Commercetools\Core\Model\CustomerGroup\CustomerGroupReference;
+use Commercetools\Core\Model\CustomObject\CustomObjectReference;
+use Commercetools\Core\Model\DiscountCode\DiscountCodeReference;
+use Commercetools\Core\Model\Order\OrderReference;
+use Commercetools\Core\Model\OrderEdit\OrderEditReference;
+use Commercetools\Core\Model\Payment\PaymentReference;
+use Commercetools\Core\Model\Product\ProductReference;
+use Commercetools\Core\Model\ProductDiscount\ProductDiscountReference;
+use Commercetools\Core\Model\ProductType\ProductTypeReference;
+use Commercetools\Core\Model\ShippingMethod\ShippingMethodReference;
+use Commercetools\Core\Model\ShoppingList\ShoppingListReference;
+use Commercetools\Core\Model\State\StateReference;
+use Commercetools\Core\Model\Store\StoreReference;
+use Commercetools\Core\Model\TaxCategory\TaxCategoryReference;
+use Commercetools\Core\Model\Type\TypeReference;
+use Commercetools\Core\Model\Zone\ZoneReference;
+
+/**
+ * @package Commercetools\Core\Model\Common
+ * @link https://docs.commercetools.com/http-api-types.html#keyreference
+ * @method string getTypeId()
+ * @method KeyReference setTypeId(string $typeId = null)
+ * @method string getId()
+ * @method KeyReference setId(string $id = null)
+ * @method string getKey()
+ * @method KeyReference setKey(string $key = null)
+ */
+class KeyReference extends ResourceIdentifier
+{
+    const TYPE_CLASS = JsonObject::class;
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     * @return static
+     */
+    public static function fromArray(array $data, $context = null)
+    {
+        if (get_called_class() == Reference::class && isset($data[static::TYPE_ID])) {
+            $className = static::referenceType($data[static::TYPE_ID]);
+            if (class_exists($className)) {
+                return new $className($data, $context);
+            }
+        }
+        return new static($data, $context);
+    }
+
+    protected static function referenceType($typeId)
+    {
+        $types = [
+            CartReference::TYPE_CART => CartReference::class,
+            CartDiscountReference::TYPE_CART_DISCOUNT => CartDiscountReference::class,
+            CategoryReference::TYPE_CATEGORY => CategoryReference::class,
+            ChannelReference::TYPE_CHANNEL => ChannelReference::class,
+            CustomerReference::TYPE_CUSTOMER => CustomerReference::class,
+            CustomObjectReference::TYPE_CUSTOM_OBJECT => CustomObjectReference::class,
+            CustomerGroupReference::TYPE_CUSTOMER_GROUP =>
+                CustomerGroupReference::class,
+            DiscountCodeReference::TYPE_DISCOUNT_CODE => DiscountCodeReference::class,
+            OrderEditReference::TYPE_ORDER_EDIT => OrderEditReference::class,
+            PaymentReference::TYPE_PAYMENT => PaymentReference::class,
+            ProductReference::TYPE_PRODUCT => ProductReference::class,
+            ProductDiscountReference::TYPE_PRODUCT_DISCOUNT =>
+                ProductDiscountReference::class,
+            ProductTypeReference::TYPE_PRODUCT_TYPE => ProductTypeReference::class,
+            OrderReference::TYPE_ORDER => OrderReference::class,
+            ShippingMethodReference::TYPE_SHIPPING_METHOD =>
+                ShippingMethodReference::class,
+            ShoppingListReference::TYPE_SHOPPING_LIST => ShoppingListReference::class,
+            StateReference::TYPE_STATE => StateReference::class,
+            StoreReference::TYPE_STORE => StoreReference::class,
+            TaxCategoryReference::TYPE_TAX_CATEGORY => TaxCategoryReference::class,
+            TypeReference::TYPE_TYPE => TypeReference::class,
+            ZoneReference::TYPE_ZONE => ZoneReference::class,
+        ];
+        return isset($types[$typeId]) ? $types[$typeId] : Reference::class;
+    }
+}