CTP SDK : File Core/Model/Common/ScopedPrice.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

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 * @created: 04.02.15, 16:43
 */

namespace Commercetools\Core\Model\Common;

use Commercetools\Core\Model\Channel\ChannelReference;
use Commercetools\Core\Model\CustomerGroup\CustomerGroupReference;
use Commercetools\Core\Model\CustomField\CustomFieldObject;
use DateTime;

/**
 * @package Commercetools\Core\Model\Common
 * @link https://docs.commercetools.com/http-api-projects-products.html#scopedprice
 * @method Money getValue()
 * @method string getCountry()
 * @method CustomerGroupReference getCustomerGroup()
 * @method ChannelReference getChannel()
 * @method DiscountedPrice getDiscounted()
 * @method ScopedPrice setValue(Money $value = null)
 * @method ScopedPrice setCountry(string $country = null)
 * @method ScopedPrice setCustomerGroup(CustomerGroupReference $customerGroup = null)
 * @method ScopedPrice setChannel(ChannelReference $channel = null)
 * @method ScopedPrice setDiscounted(DiscountedPrice $discounted = null)
 * @method string getId()
 * @method ScopedPrice setId(string $id = null)
 * @method DateTimeDecorator getValidFrom()
 * @method ScopedPrice setValidFrom(DateTime $validFrom = null)
 * @method DateTimeDecorator getValidUntil()
 * @method ScopedPrice setValidUntil(DateTime $validUntil = null)
 * @method CustomFieldObject getCustom()
 * @method ScopedPrice setCustom(CustomFieldObject $custom = null)
 * @method Money getCurrentValue()
 * @method ScopedPrice setCurrentValue(Money $currentValue = null)
 */
class ScopedPrice extends JsonObject
{
    const ID = 'id';
    const VALUE = 'value';
    const CURRENT_VALUE = 'currentValue';
    const COUNTRY = 'country';
    const CUSTOMER_GROUP = 'customerGroup';
    const CHANNEL = 'channel';
    const VALID_FROM = 'validFrom';
    const VALID_UNTIL = 'validUntil';
    const DISCOUNTED = 'discounted';
    const CUSTOM = 'custom';

    public function fieldDefinitions()
    {
        return [
            static::ID => [static::TYPE => 'string'],
            static::VALUE => [self::TYPE => Money::class],
            static::CURRENT_VALUE => [static::TYPE => Money::class],
            static::COUNTRY => [self::TYPE => 'string', static::OPTIONAL => true],
            static::CUSTOMER_GROUP => [self::TYPE => CustomerGroupReference::class, static::OPTIONAL => true],
            static::CHANNEL => [self::TYPE => ChannelReference::class, static::OPTIONAL => true],
            static::VALID_FROM => [
                self::TYPE => DateTime::class,
                static::OPTIONAL => true,
                self::DECORATOR => DateTimeDecorator::class
            ],
            static::VALID_UNTIL => [
                self::TYPE => DateTime::class,
                static::OPTIONAL => true,
                self::DECORATOR => DateTimeDecorator::class
            ],
            static::DISCOUNTED => [self::TYPE => DiscountedPrice::class, static::OPTIONAL => true],
            static::CUSTOM => [static::TYPE => CustomFieldObject::class, static::OPTIONAL => true],
        ];
    }

    /**
     * @param Money $money
     * @param Context|callable $context
     * @return ScopedPrice
     */
    public static function ofMoney(Money $money, $context = null)
    {
        $price = static::of($context);
        return $price->setValue($money);
    }

    public function __toString()
    {
        return $this->getCurrentValue()->__toString();
    }
}

Namespaces

Classes

Interfaces

Traits