ShippingMethodModel.php

<?php
 
declare(strict_types=1);
namespace Commercetools\Api\Models\ShippingMethod;
 
use Commercetools\Api\Models\Common\BaseResource;
use Commercetools\Api\Models\Common\BaseResourceModel;
use Commercetools\Api\Models\Common\CreatedBy;
use Commercetools\Api\Models\Common\CreatedByModel;
use Commercetools\Api\Models\Common\LastModifiedBy;
use Commercetools\Api\Models\Common\LastModifiedByModel;
use Commercetools\Api\Models\Common\LocalizedString;
use Commercetools\Api\Models\Common\LocalizedStringModel;
use Commercetools\Api\Models\Store\StoreKeyReferenceCollection;
use Commercetools\Api\Models\TaxCategory\TaxCategoryReference;
use Commercetools\Api\Models\TaxCategory\TaxCategoryReferenceModel;
use Commercetools\Api\Models\Type\CustomFields;
use Commercetools\Api\Models\Type\CustomFieldsModel;
use Commercetools\Base\DateTimeImmutableCollection;
use Commercetools\Base\JsonObject;
use Commercetools\Base\JsonObjectModel;
use Commercetools\Base\MapperFactory;
use DateTimeImmutable;
use stdClass;
 
final class ShippingMethodModel extends JsonObjectModel implements ShippingMethod
{
    protected $id;
 
    protected $version;
 
    protected $createdAt;
 
    protected $lastModifiedAt;
 
    protected $lastModifiedBy;
 
    protected $createdBy;
 
    protected $key;
 
    protected $name;
 
    protected $localizedName;
 
    protected $description;
 
    protected $localizedDescription;
 
    protected $taxCategory;
 
    protected $zoneRates;
 
    protected $active;
 
    protected $isDefault;
 
    protected $predicate;
 
    protected $custom;
 
    protected $stores;
 
    protected $carrier;
 
 
    public function __construct(
        ?string $id = null,
        ?int $version = null,
        ?DateTimeImmutable $createdAt = null,
        ?DateTimeImmutable $lastModifiedAt = null,
        ?LastModifiedBy $lastModifiedBy = null,
        ?CreatedBy $createdBy = null,
        ?string $key = null,
        ?string $name = null,
        ?LocalizedString $localizedName = null,
        ?string $description = null,
        ?LocalizedString $localizedDescription = null,
        ?TaxCategoryReference $taxCategory = null,
        ?ZoneRateCollection $zoneRates = null,
        ?bool $active = null,
        ?bool $isDefault = null,
        ?string $predicate = null,
        ?CustomFields $custom = null,
        ?StoreKeyReferenceCollection $stores = null,
        ?string $carrier = null
    ) {
        $this->id = $id;
        $this->version = $version;
        $this->createdAt = $createdAt;
        $this->lastModifiedAt = $lastModifiedAt;
        $this->lastModifiedBy = $lastModifiedBy;
        $this->createdBy = $createdBy;
        $this->key = $key;
        $this->name = $name;
        $this->localizedName = $localizedName;
        $this->description = $description;
        $this->localizedDescription = $localizedDescription;
        $this->taxCategory = $taxCategory;
        $this->zoneRates = $zoneRates;
        $this->active = $active;
        $this->isDefault = $isDefault;
        $this->predicate = $predicate;
        $this->custom = $custom;
        $this->stores = $stores;
        $this->carrier = $carrier;
    }
 
    public function getId()
    {
        if (is_null($this->id)) {
            $data = $this->raw(self::FIELD_ID);
            if (is_null($data)) {
                return null;
            }
            $this->id = (string) $data;
        }
 
        return $this->id;
    }
 
    public function getVersion()
    {
        if (is_null($this->version)) {
            $data = $this->raw(self::FIELD_VERSION);
            if (is_null($data)) {
                return null;
            }
            $this->version = (int) $data;
        }
 
        return $this->version;
    }
 
    public function getCreatedAt()
    {
        if (is_null($this->createdAt)) {
            $data = $this->raw(self::FIELD_CREATED_AT);
            if (is_null($data)) {
                return null;
            }
            $data = DateTimeImmutable::createFromFormat(MapperFactory::DATETIME_FORMAT, $data);
            if (false === $data) {
                return null;
            }
            $this->createdAt = $data;
        }
 
        return $this->createdAt;
    }
 
    public function getLastModifiedAt()
    {
        if (is_null($this->lastModifiedAt)) {
            $data = $this->raw(self::FIELD_LAST_MODIFIED_AT);
            if (is_null($data)) {
                return null;
            }
            $data = DateTimeImmutable::createFromFormat(MapperFactory::DATETIME_FORMAT, $data);
            if (false === $data) {
                return null;
            }
            $this->lastModifiedAt = $data;
        }
 
        return $this->lastModifiedAt;
    }
 
    public function getLastModifiedBy()
    {
        if (is_null($this->lastModifiedBy)) {
            $data = $this->raw(self::FIELD_LAST_MODIFIED_BY);
            if (is_null($data)) {
                return null;
            }
 
            $this->lastModifiedBy = LastModifiedByModel::of($data);
        }
 
        return $this->lastModifiedBy;
    }
 
    public function getCreatedBy()
    {
        if (is_null($this->createdBy)) {
            $data = $this->raw(self::FIELD_CREATED_BY);
            if (is_null($data)) {
                return null;
            }
 
            $this->createdBy = CreatedByModel::of($data);
        }
 
        return $this->createdBy;
    }
 
    public function getKey()
    {
        if (is_null($this->key)) {
            $data = $this->raw(self::FIELD_KEY);
            if (is_null($data)) {
                return null;
            }
            $this->key = (string) $data;
        }
 
        return $this->key;
    }
 
    public function getName()
    {
        if (is_null($this->name)) {
            $data = $this->raw(self::FIELD_NAME);
            if (is_null($data)) {
                return null;
            }
            $this->name = (string) $data;
        }
 
        return $this->name;
    }
 
    public function getLocalizedName()
    {
        if (is_null($this->localizedName)) {
            $data = $this->raw(self::FIELD_LOCALIZED_NAME);
            if (is_null($data)) {
                return null;
            }
 
            $this->localizedName = LocalizedStringModel::of($data);
        }
 
        return $this->localizedName;
    }
 
    public function getDescription()
    {
        if (is_null($this->description)) {
            $data = $this->raw(self::FIELD_DESCRIPTION);
            if (is_null($data)) {
                return null;
            }
            $this->description = (string) $data;
        }
 
        return $this->description;
    }
 
    public function getLocalizedDescription()
    {
        if (is_null($this->localizedDescription)) {
            $data = $this->raw(self::FIELD_LOCALIZED_DESCRIPTION);
            if (is_null($data)) {
                return null;
            }
 
            $this->localizedDescription = LocalizedStringModel::of($data);
        }
 
        return $this->localizedDescription;
    }
 
    public function getTaxCategory()
    {
        if (is_null($this->taxCategory)) {
            $data = $this->raw(self::FIELD_TAX_CATEGORY);
            if (is_null($data)) {
                return null;
            }
 
            $this->taxCategory = TaxCategoryReferenceModel::of($data);
        }
 
        return $this->taxCategory;
    }
 
    public function getZoneRates()
    {
        if (is_null($this->zoneRates)) {
            $data = $this->raw(self::FIELD_ZONE_RATES);
            if (is_null($data)) {
                return null;
            }
            $this->zoneRates = ZoneRateCollection::fromArray($data);
        }
 
        return $this->zoneRates;
    }
 
    public function getActive()
    {
        if (is_null($this->active)) {
            $data = $this->raw(self::FIELD_ACTIVE);
            if (is_null($data)) {
                return null;
            }
            $this->active = (bool) $data;
        }
 
        return $this->active;
    }
 
    public function getIsDefault()
    {
        if (is_null($this->isDefault)) {
            $data = $this->raw(self::FIELD_IS_DEFAULT);
            if (is_null($data)) {
                return null;
            }
            $this->isDefault = (bool) $data;
        }
 
        return $this->isDefault;
    }
 
    public function getPredicate()
    {
        if (is_null($this->predicate)) {
            $data = $this->raw(self::FIELD_PREDICATE);
            if (is_null($data)) {
                return null;
            }
            $this->predicate = (string) $data;
        }
 
        return $this->predicate;
    }
 
    public function getCustom()
    {
        if (is_null($this->custom)) {
            $data = $this->raw(self::FIELD_CUSTOM);
            if (is_null($data)) {
                return null;
            }
 
            $this->custom = CustomFieldsModel::of($data);
        }
 
        return $this->custom;
    }
 
    public function getStores()
    {
        if (is_null($this->stores)) {
            $data = $this->raw(self::FIELD_STORES);
            if (is_null($data)) {
                return null;
            }
            $this->stores = StoreKeyReferenceCollection::fromArray($data);
        }
 
        return $this->stores;
    }
 
    public function getCarrier()
    {
        if (is_null($this->carrier)) {
            $data = $this->raw(self::FIELD_CARRIER);
            if (is_null($data)) {
                return null;
            }
            $this->carrier = (string) $data;
        }
 
        return $this->carrier;
    }
 
 
    public function setId(?string $id): void
    {
        $this->id = $id;
    }
 
    public function setVersion(?int $version): void
    {
        $this->version = $version;
    }
 
    public function setCreatedAt(?DateTimeImmutable $createdAt): void
    {
        $this->createdAt = $createdAt;
    }
 
    public function setLastModifiedAt(?DateTimeImmutable $lastModifiedAt): void
    {
        $this->lastModifiedAt = $lastModifiedAt;
    }
 
    public function setLastModifiedBy(?LastModifiedBy $lastModifiedBy): void
    {
        $this->lastModifiedBy = $lastModifiedBy;
    }
 
    public function setCreatedBy(?CreatedBy $createdBy): void
    {
        $this->createdBy = $createdBy;
    }
 
    public function setKey(?string $key): void
    {
        $this->key = $key;
    }
 
    public function setName(?string $name): void
    {
        $this->name = $name;
    }
 
    public function setLocalizedName(?LocalizedString $localizedName): void
    {
        $this->localizedName = $localizedName;
    }
 
    public function setDescription(?string $description): void
    {
        $this->description = $description;
    }
 
    public function setLocalizedDescription(?LocalizedString $localizedDescription): void
    {
        $this->localizedDescription = $localizedDescription;
    }
 
    public function setTaxCategory(?TaxCategoryReference $taxCategory): void
    {
        $this->taxCategory = $taxCategory;
    }
 
    public function setZoneRates(?ZoneRateCollection $zoneRates): void
    {
        $this->zoneRates = $zoneRates;
    }
 
    public function setActive(?bool $active): void
    {
        $this->active = $active;
    }
 
    public function setIsDefault(?bool $isDefault): void
    {
        $this->isDefault = $isDefault;
    }
 
    public function setPredicate(?string $predicate): void
    {
        $this->predicate = $predicate;
    }
 
    public function setCustom(?CustomFields $custom): void
    {
        $this->custom = $custom;
    }
 
    public function setStores(?StoreKeyReferenceCollection $stores): void
    {
        $this->stores = $stores;
    }
 
    public function setCarrier(?string $carrier): void
    {
        $this->carrier = $carrier;
    }
 
 
    #[\ReturnTypeWillChange]
    public function jsonSerialize()
    {
        $data = $this->toArray();
        if (isset($data[ShippingMethod::FIELD_CREATED_AT]) && $data[ShippingMethod::FIELD_CREATED_AT] instanceof \DateTimeImmutable) {
            $data[ShippingMethod::FIELD_CREATED_AT] = $data[ShippingMethod::FIELD_CREATED_AT]->setTimeZone(new \DateTimeZone('UTC'))->format('c');
        }
 
        if (isset($data[ShippingMethod::FIELD_LAST_MODIFIED_AT]) && $data[ShippingMethod::FIELD_LAST_MODIFIED_AT] instanceof \DateTimeImmutable) {
            $data[ShippingMethod::FIELD_LAST_MODIFIED_AT] = $data[ShippingMethod::FIELD_LAST_MODIFIED_AT]->setTimeZone(new \DateTimeZone('UTC'))->format('c');
        }
        return (object) $data;
    }
}