vendor/shopware/core/System/Country/CountryEntity.php line 18

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\Country;
  5. use Shopware\Core\Checkout\Customer\Aggregate\CustomerAddress\CustomerAddressCollection;
  6. use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressCollection;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  8. use Shopware\Core\Framework\DataAbstractionLayer\EntityCustomFieldsTrait;
  9. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  10. use Shopware\Core\Framework\DataAbstractionLayer\TaxFreeConfig;
  11. use Shopware\Core\Framework\Feature;
  12. use Shopware\Core\System\Country\Aggregate\CountryState\CountryStateCollection;
  13. use Shopware\Core\System\Country\Aggregate\CountryTranslation\CountryTranslationCollection;
  14. use Shopware\Core\System\Currency\Aggregate\CurrencyCountryRounding\CurrencyCountryRoundingCollection;
  15. use Shopware\Core\System\SalesChannel\SalesChannelCollection;
  16. use Shopware\Core\System\Tax\Aggregate\TaxRule\TaxRuleCollection;
  18. class CountryEntity extends Entity
  19. {
  20.     use EntityIdTrait;
  21.     use EntityCustomFieldsTrait;
  23.     /**
  24.      * @var string|null
  25.      */
  26.     protected $name;
  28.     /**
  29.      * @var string|null
  30.      */
  31.     protected $iso;
  33.     /**
  34.      * @var int
  35.      */
  36.     protected $position;
  38.     /**
  39.      * @var bool
  40.      *
  41.      * @deprecated tag:v6.5.0 - Will be removed, use $customerTax->getEnabled() instead
  42.      */
  43.     protected $taxFree;
  45.     /**
  46.      * @var bool
  47.      */
  48.     protected $active;
  50.     /**
  51.      * @var bool
  52.      */
  53.     protected $shippingAvailable;
  55.     /**
  56.      * @var string|null
  57.      */
  58.     protected $iso3;
  60.     /**
  61.      * @var bool
  62.      */
  63.     protected $displayStateInRegistration;
  65.     /**
  66.      * @var bool
  67.      */
  68.     protected $forceStateInRegistration;
  70.     /**
  71.      * @var bool
  72.      *
  73.      * @deprecated tag:v6.5.0 - Will be removed, use $companyTax->getEnabled() instead
  74.      */
  75.     protected $companyTaxFree;
  77.     /**
  78.      * @var bool
  79.      */
  80.     protected $checkVatIdPattern;
  82.     /**
  83.      * @var string|null
  84.      */
  85.     protected $vatIdPattern;
  87.     /**
  88.      * @var bool|null
  89.      */
  90.     protected $vatIdRequired;
  92.     protected TaxFreeConfig $customerTax;
  94.     protected TaxFreeConfig $companyTax;
  96.     /**
  97.      * @var CountryStateCollection|null
  98.      */
  99.     protected $states;
  101.     /**
  102.      * @var CountryTranslationCollection|null
  103.      */
  104.     protected $translations;
  106.     /**
  107.      * @var OrderAddressCollection|null
  108.      */
  109.     protected $orderAddresses;
  111.     /**
  112.      * @var CustomerAddressCollection|null
  113.      */
  114.     protected $customerAddresses;
  116.     /**
  117.      * @var SalesChannelCollection|null
  118.      */
  119.     protected $salesChannelDefaultAssignments;
  121.     /**
  122.      * @var SalesChannelCollection|null
  123.      */
  124.     protected $salesChannels;
  126.     /**
  127.      * @var TaxRuleCollection|null
  128.      */
  129.     protected $taxRules;
  131.     /**
  132.      * @var CurrencyCountryRoundingCollection|null
  133.      */
  134.     protected $currencyCountryRoundings;
  136.     protected bool $postalCodeRequired;
  138.     protected bool $checkPostalCodePattern;
  140.     protected bool $checkAdvancedPostalCodePattern;
  142.     protected ?string $advancedPostalCodePattern;
  144.     protected ?string $defaultPostalCodePattern;
  146.     /**
  147.      * @var array<array<string, array<string, string>>>
  148.      */
  149.     protected array $addressFormat;
  151.     public function getName(): ?string
  152.     {
  153.         return $this->name;
  154.     }
  156.     public function setName(?string $name): void
  157.     {
  158.         $this->name = $name;
  159.     }
  161.     public function getIso(): ?string
  162.     {
  163.         return $this->iso;
  164.     }
  166.     public function setIso(?string $iso): void
  167.     {
  168.         $this->iso = $iso;
  169.     }
  171.     public function getPosition(): int
  172.     {
  173.         return $this->position;
  174.     }
  176.     public function setPosition(int $position): void
  177.     {
  178.         $this->position = $position;
  179.     }
  181.     /**
  182.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  183.      */
  184.     public function getTaxFree(): bool
  185.     {
  186.         Feature::triggerDeprecationOrThrow(
  187.             'v6.5.0.0',
  188.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCustomerTax->getEnabled()')
  189.         );
  191.         return $this->taxFree;
  192.     }
  194.     /**
  195.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  196.      */
  197.     public function setTaxFree(bool $taxFree): void
  198.     {
  199.         Feature::triggerDeprecationOrThrow(
  200.             'v6.5.0.0',
  201.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCustomerTax->setEnabled()')
  202.         );
  204.         $this->taxFree = $taxFree;
  205.     }
  207.     public function getActive(): bool
  208.     {
  209.         return $this->active;
  210.     }
  212.     public function setActive(bool $active): void
  213.     {
  214.         $this->active = $active;
  215.     }
  217.     public function getShippingAvailable(): bool
  218.     {
  219.         return $this->shippingAvailable;
  220.     }
  222.     public function setShippingAvailable(bool $shippingAvailable): void
  223.     {
  224.         $this->shippingAvailable = $shippingAvailable;
  225.     }
  227.     public function getIso3(): ?string
  228.     {
  229.         return $this->iso3;
  230.     }
  232.     public function setIso3(?string $iso3): void
  233.     {
  234.         $this->iso3 = $iso3;
  235.     }
  237.     public function getDisplayStateInRegistration(): bool
  238.     {
  239.         return $this->displayStateInRegistration;
  240.     }
  242.     public function setDisplayStateInRegistration(bool $displayStateInRegistration): void
  243.     {
  244.         $this->displayStateInRegistration = $displayStateInRegistration;
  245.     }
  247.     public function getForceStateInRegistration(): bool
  248.     {
  249.         return $this->forceStateInRegistration;
  250.     }
  252.     public function setForceStateInRegistration(bool $forceStateInRegistration): void
  253.     {
  254.         $this->forceStateInRegistration = $forceStateInRegistration;
  255.     }
  257.     /**
  258.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  259.      */
  260.     public function getCompanyTaxFree(): bool
  261.     {
  262.         Feature::triggerDeprecationOrThrow(
  263.             'v6.5.0.0',
  264.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCompanyTax->getEnabled()')
  265.         );
  267.         return $this->companyTaxFree;
  268.     }
  270.     /**
  271.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  272.      */
  273.     public function setCompanyTaxFree(bool $companyTaxFree): void
  274.     {
  275.         Feature::triggerDeprecationOrThrow(
  276.             'v6.5.0.0',
  277.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCompanyTax->setEnabled()')
  278.         );
  280.         $this->companyTaxFree = $companyTaxFree;
  281.     }
  283.     public function getCheckVatIdPattern(): bool
  284.     {
  285.         return $this->checkVatIdPattern;
  286.     }
  288.     public function setCheckVatIdPattern(bool $checkVatIdPattern): void
  289.     {
  290.         $this->checkVatIdPattern = $checkVatIdPattern;
  291.     }
  293.     public function getVatIdPattern(): ?string
  294.     {
  295.         return $this->vatIdPattern;
  296.     }
  298.     public function setVatIdPattern(?string $vatIdPattern): void
  299.     {
  300.         $this->vatIdPattern = $vatIdPattern;
  301.     }
  303.     public function getStates(): ?CountryStateCollection
  304.     {
  305.         return $this->states;
  306.     }
  308.     public function setStates(CountryStateCollection $states): void
  309.     {
  310.         $this->states = $states;
  311.     }
  313.     public function getTranslations(): ?CountryTranslationCollection
  314.     {
  315.         return $this->translations;
  316.     }
  318.     public function setTranslations(CountryTranslationCollection $translations): void
  319.     {
  320.         $this->translations = $translations;
  321.     }
  323.     public function getOrderAddresses(): ?OrderAddressCollection
  324.     {
  325.         return $this->orderAddresses;
  326.     }
  328.     public function setOrderAddresses(OrderAddressCollection $orderAddresses): void
  329.     {
  330.         $this->orderAddresses = $orderAddresses;
  331.     }
  333.     public function getCustomerAddresses(): ?CustomerAddressCollection
  334.     {
  335.         return $this->customerAddresses;
  336.     }
  338.     public function setCustomerAddresses(CustomerAddressCollection $customerAddresses): void
  339.     {
  340.         $this->customerAddresses = $customerAddresses;
  341.     }
  343.     public function getSalesChannelDefaultAssignments(): ?SalesChannelCollection
  344.     {
  345.         return $this->salesChannelDefaultAssignments;
  346.     }
  348.     public function setSalesChannelDefaultAssignments(SalesChannelCollection $salesChannelDefaultAssignments): void
  349.     {
  350.         $this->salesChannelDefaultAssignments = $salesChannelDefaultAssignments;
  351.     }
  353.     public function getSalesChannels(): ?SalesChannelCollection
  354.     {
  355.         return $this->salesChannels;
  356.     }
  358.     public function setSalesChannels(SalesChannelCollection $salesChannels): void
  359.     {
  360.         $this->salesChannels = $salesChannels;
  361.     }
  363.     public function getTaxRules(): ?TaxRuleCollection
  364.     {
  365.         return $this->taxRules;
  366.     }
  368.     public function setTaxRules(TaxRuleCollection $taxRules): void
  369.     {
  370.         $this->taxRules = $taxRules;
  371.     }
  373.     public function getCurrencyCountryRoundings(): ?CurrencyCountryRoundingCollection
  374.     {
  375.         return $this->currencyCountryRoundings;
  376.     }
  378.     public function setCurrencyCountryRoundings(CurrencyCountryRoundingCollection $currencyCountryRoundings): void
  379.     {
  380.         $this->currencyCountryRoundings = $currencyCountryRoundings;
  381.     }
  383.     public function getVatIdRequired(): bool
  384.     {
  385.         return (bool) $this->vatIdRequired;
  386.     }
  388.     public function setVatIdRequired(bool $vatIdRequired): void
  389.     {
  390.         $this->vatIdRequired = $vatIdRequired;
  391.     }
  393.     public function getCustomerTax(): TaxFreeConfig
  394.     {
  395.         return $this->customerTax;
  396.     }
  398.     public function setCustomerTax(TaxFreeConfig $customerTax): void
  399.     {
  400.         $this->customerTax = $customerTax;
  401.     }
  403.     public function getCompanyTax(): TaxFreeConfig
  404.     {
  405.         return $this->companyTax;
  406.     }
  408.     public function setCompanyTax(TaxFreeConfig $companyTax): void
  409.     {
  410.         $this->companyTax = $companyTax;
  411.     }
  413.     public function getPostalCodeRequired(): bool
  414.     {
  415.         if (!Feature::isActive('v6.5.0.0')) {
  416.             return true;
  417.         }
  419.         return $this->postalCodeRequired;
  420.     }
  422.     public function setPostalCodeRequired(bool $postalCodeRequired): void
  423.     {
  424.         $this->postalCodeRequired = $postalCodeRequired;
  425.     }
  427.     public function getCheckPostalCodePattern(): bool
  428.     {
  429.         return $this->checkPostalCodePattern;
  430.     }
  432.     public function setCheckPostalCodePattern(bool $checkPostalCodePattern): void
  433.     {
  434.         $this->checkPostalCodePattern = $checkPostalCodePattern;
  435.     }
  437.     public function getCheckAdvancedPostalCodePattern(): bool
  438.     {
  439.         return $this->checkAdvancedPostalCodePattern;
  440.     }
  442.     public function setCheckAdvancedPostalCodePattern(bool $checkAdvancedPostalCodePattern): void
  443.     {
  444.         $this->checkAdvancedPostalCodePattern = $checkAdvancedPostalCodePattern;
  445.     }
  447.     public function getAdvancedPostalCodePattern(): ?string
  448.     {
  449.         return $this->advancedPostalCodePattern;
  450.     }
  452.     public function setAdvancedPostalCodePattern(?string $advancedPostalCodePattern): void
  453.     {
  454.         $this->advancedPostalCodePattern = $advancedPostalCodePattern;
  455.     }
  457.     /**
  458.      * @return array<array<string, array<string, string>>>
  459.      */
  460.     public function getAddressFormat(): array
  461.     {
  462.         return $this->addressFormat;
  463.     }
  465.     /**
  466.      * @param array<array<string, array<string, string>>> $addressFormat
  467.      */
  468.     public function setAddressFormat(array $addressFormat): void
  469.     {
  470.         $this->addressFormat = $addressFormat;
  471.     }
  473.     public function setDefaultPostalCodePattern(?string $pattern): void
  474.     {
  475.         $this->defaultPostalCodePattern = $pattern;
  476.     }
  478.     public function getDefaultPostalCodePattern(): ?string
  479.     {
  480.         return $this->defaultPostalCodePattern;
  481.     }
  482. }