CTP SDK : File Core/Model/Common/KeyReference.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100

<?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
 * @ramlTestIgnoreFields('id')
 * @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;

    public function fieldDefinitions()
    {
        return [
            static::TYPE_ID => [self::TYPE => 'string'],
            static::ID => [self::TYPE => 'string', static::OPTIONAL => true],
            static::KEY => [self::TYPE => 'string']
        ];
    }

    /**
     * @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;
    }
}

Namespaces

Classes

Interfaces

Traits