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

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\Framework\Log\Package;
  13. use Shopware\Core\System\Country\Aggregate\CountryState\CountryStateCollection;
  14. use Shopware\Core\System\Country\Aggregate\CountryTranslation\CountryTranslationCollection;
  15. use Shopware\Core\System\Currency\Aggregate\CurrencyCountryRounding\CurrencyCountryRoundingCollection;
  16. use Shopware\Core\System\SalesChannel\SalesChannelCollection;
  17. use Shopware\Core\System\Tax\Aggregate\TaxRule\TaxRuleCollection;
  19. #[Package('system-settings')]
  20. class CountryEntity extends Entity
  21. {
  22.     use EntityIdTrait;
  23.     use EntityCustomFieldsTrait;
  25.     /**
  26.      * @var string|null
  27.      */
  28.     protected $name;
  30.     /**
  31.      * @var string|null
  32.      */
  33.     protected $iso;
  35.     /**
  36.      * @var int
  37.      */
  38.     protected $position;
  40.     /**
  41.      * @var bool
  42.      *
  43.      * @deprecated tag:v6.5.0 - Will be removed, use $customerTax->getEnabled() instead
  44.      */
  45.     protected $taxFree;
  47.     /**
  48.      * @var bool
  49.      */
  50.     protected $active;
  52.     /**
  53.      * @var bool
  54.      */
  55.     protected $shippingAvailable;
  57.     /**
  58.      * @var string|null
  59.      */
  60.     protected $iso3;
  62.     /**
  63.      * @var bool
  64.      */
  65.     protected $displayStateInRegistration;
  67.     /**
  68.      * @var bool
  69.      */
  70.     protected $forceStateInRegistration;
  72.     /**
  73.      * @var bool
  74.      *
  75.      * @deprecated tag:v6.5.0 - Will be removed, use $companyTax->getEnabled() instead
  76.      */
  77.     protected $companyTaxFree;
  79.     /**
  80.      * @var bool
  81.      */
  82.     protected $checkVatIdPattern;
  84.     /**
  85.      * @var string|null
  86.      */
  87.     protected $vatIdPattern;
  89.     /**
  90.      * @var bool|null
  91.      */
  92.     protected $vatIdRequired;
  94.     protected TaxFreeConfig $customerTax;
  96.     protected TaxFreeConfig $companyTax;
  98.     /**
  99.      * @var CountryStateCollection|null
  100.      */
  101.     protected $states;
  103.     /**
  104.      * @var CountryTranslationCollection|null
  105.      */
  106.     protected $translations;
  108.     /**
  109.      * @var OrderAddressCollection|null
  110.      */
  111.     protected $orderAddresses;
  113.     /**
  114.      * @var CustomerAddressCollection|null
  115.      */
  116.     protected $customerAddresses;
  118.     /**
  119.      * @var SalesChannelCollection|null
  120.      */
  121.     protected $salesChannelDefaultAssignments;
  123.     /**
  124.      * @var SalesChannelCollection|null
  125.      */
  126.     protected $salesChannels;
  128.     /**
  129.      * @var TaxRuleCollection|null
  130.      */
  131.     protected $taxRules;
  133.     /**
  134.      * @var CurrencyCountryRoundingCollection|null
  135.      */
  136.     protected $currencyCountryRoundings;
  138.     protected bool $postalCodeRequired;
  140.     protected bool $checkPostalCodePattern;
  142.     protected bool $checkAdvancedPostalCodePattern;
  144.     protected ?string $advancedPostalCodePattern;
  146.     protected ?string $defaultPostalCodePattern;
  148.     /**
  149.      * @var array<array<string, array<string, string>>>
  150.      */
  151.     protected array $addressFormat;
  153.     public function getName(): ?string
  154.     {
  155.         return $this->name;
  156.     }
  158.     public function setName(?string $name): void
  159.     {
  160.         $this->name = $name;
  161.     }
  163.     public function getIso(): ?string
  164.     {
  165.         return $this->iso;
  166.     }
  168.     public function setIso(?string $iso): void
  169.     {
  170.         $this->iso = $iso;
  171.     }
  173.     public function getPosition(): int
  174.     {
  175.         return $this->position;
  176.     }
  178.     public function setPosition(int $position): void
  179.     {
  180.         $this->position = $position;
  181.     }
  183.     /**
  184.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  185.      */
  186.     public function getTaxFree(): bool
  187.     {
  188.         Feature::triggerDeprecationOrThrow(
  189.             'v6.5.0.0',
  190.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCustomerTax->getEnabled()')
  191.         );
  193.         return $this->taxFree;
  194.     }
  196.     /**
  197.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  198.      */
  199.     public function setTaxFree(bool $taxFree): void
  200.     {
  201.         Feature::triggerDeprecationOrThrow(
  202.             'v6.5.0.0',
  203.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCustomerTax->setEnabled()')
  204.         );
  206.         $this->taxFree = $taxFree;
  207.     }
  209.     public function getActive(): bool
  210.     {
  211.         return $this->active;
  212.     }
  214.     public function setActive(bool $active): void
  215.     {
  216.         $this->active = $active;
  217.     }
  219.     public function getShippingAvailable(): bool
  220.     {
  221.         return $this->shippingAvailable;
  222.     }
  224.     public function setShippingAvailable(bool $shippingAvailable): void
  225.     {
  226.         $this->shippingAvailable = $shippingAvailable;
  227.     }
  229.     public function getIso3(): ?string
  230.     {
  231.         return $this->iso3;
  232.     }
  234.     public function setIso3(?string $iso3): void
  235.     {
  236.         $this->iso3 = $iso3;
  237.     }
  239.     public function getDisplayStateInRegistration(): bool
  240.     {
  241.         return $this->displayStateInRegistration;
  242.     }
  244.     public function setDisplayStateInRegistration(bool $displayStateInRegistration): void
  245.     {
  246.         $this->displayStateInRegistration = $displayStateInRegistration;
  247.     }
  249.     public function getForceStateInRegistration(): bool
  250.     {
  251.         return $this->forceStateInRegistration;
  252.     }
  254.     public function setForceStateInRegistration(bool $forceStateInRegistration): void
  255.     {
  256.         $this->forceStateInRegistration = $forceStateInRegistration;
  257.     }
  259.     /**
  260.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  261.      */
  262.     public function getCompanyTaxFree(): bool
  263.     {
  264.         Feature::triggerDeprecationOrThrow(
  265.             'v6.5.0.0',
  266.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCompanyTax->getEnabled()')
  267.         );
  269.         return $this->companyTaxFree;
  270.     }
  272.     /**
  273.      * @deprecated tag:v6.5.0 - Will be removed in version 6.5.0
  274.      */
  275.     public function setCompanyTaxFree(bool $companyTaxFree): void
  276.     {
  277.         Feature::triggerDeprecationOrThrow(
  278.             'v6.5.0.0',
  279.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'CountryEntity->getCompanyTax->setEnabled()')
  280.         );
  282.         $this->companyTaxFree = $companyTaxFree;
  283.     }
  285.     public function getCheckVatIdPattern(): bool
  286.     {
  287.         return $this->checkVatIdPattern;
  288.     }
  290.     public function setCheckVatIdPattern(bool $checkVatIdPattern): void
  291.     {
  292.         $this->checkVatIdPattern = $checkVatIdPattern;
  293.     }
  295.     public function getVatIdPattern(): ?string
  296.     {
  297.         return $this->vatIdPattern;
  298.     }
  300.     public function setVatIdPattern(?string $vatIdPattern): void
  301.     {
  302.         $this->vatIdPattern = $vatIdPattern;
  303.     }
  305.     public function getStates(): ?CountryStateCollection
  306.     {
  307.         return $this->states;
  308.     }
  310.     public function setStates(CountryStateCollection $states): void
  311.     {
  312.         $this->states = $states;
  313.     }
  315.     public function getTranslations(): ?CountryTranslationCollection
  316.     {
  317.         return $this->translations;
  318.     }
  320.     public function setTranslations(CountryTranslationCollection $translations): void
  321.     {
  322.         $this->translations = $translations;
  323.     }
  325.     public function getOrderAddresses(): ?OrderAddressCollection
  326.     {
  327.         return $this->orderAddresses;
  328.     }
  330.     public function setOrderAddresses(OrderAddressCollection $orderAddresses): void
  331.     {
  332.         $this->orderAddresses = $orderAddresses;
  333.     }
  335.     public function getCustomerAddresses(): ?CustomerAddressCollection
  336.     {
  337.         return $this->customerAddresses;
  338.     }
  340.     public function setCustomerAddresses(CustomerAddressCollection $customerAddresses): void
  341.     {
  342.         $this->customerAddresses = $customerAddresses;
  343.     }
  345.     public function getSalesChannelDefaultAssignments(): ?SalesChannelCollection
  346.     {
  347.         return $this->salesChannelDefaultAssignments;
  348.     }
  350.     public function setSalesChannelDefaultAssignments(SalesChannelCollection $salesChannelDefaultAssignments): void
  351.     {
  352.         $this->salesChannelDefaultAssignments = $salesChannelDefaultAssignments;
  353.     }
  355.     public function getSalesChannels(): ?SalesChannelCollection
  356.     {
  357.         return $this->salesChannels;
  358.     }
  360.     public function setSalesChannels(SalesChannelCollection $salesChannels): void
  361.     {
  362.         $this->salesChannels = $salesChannels;
  363.     }
  365.     public function getTaxRules(): ?TaxRuleCollection
  366.     {
  367.         return $this->taxRules;
  368.     }
  370.     public function setTaxRules(TaxRuleCollection $taxRules): void
  371.     {
  372.         $this->taxRules = $taxRules;
  373.     }
  375.     public function getCurrencyCountryRoundings(): ?CurrencyCountryRoundingCollection
  376.     {
  377.         return $this->currencyCountryRoundings;
  378.     }
  380.     public function setCurrencyCountryRoundings(CurrencyCountryRoundingCollection $currencyCountryRoundings): void
  381.     {
  382.         $this->currencyCountryRoundings = $currencyCountryRoundings;
  383.     }
  385.     public function getVatIdRequired(): bool
  386.     {
  387.         return (bool) $this->vatIdRequired;
  388.     }
  390.     public function setVatIdRequired(bool $vatIdRequired): void
  391.     {
  392.         $this->vatIdRequired = $vatIdRequired;
  393.     }
  395.     public function getCustomerTax(): TaxFreeConfig
  396.     {
  397.         return $this->customerTax;
  398.     }
  400.     public function setCustomerTax(TaxFreeConfig $customerTax): void
  401.     {
  402.         $this->customerTax = $customerTax;
  403.     }
  405.     public function getCompanyTax(): TaxFreeConfig
  406.     {
  407.         return $this->companyTax;
  408.     }
  410.     public function setCompanyTax(TaxFreeConfig $companyTax): void
  411.     {
  412.         $this->companyTax = $companyTax;
  413.     }
  415.     public function getPostalCodeRequired(): bool
  416.     {
  417.         if (!Feature::isActive('v6.5.0.0')) {
  418.             return true;
  419.         }
  421.         return $this->postalCodeRequired;
  422.     }
  424.     public function setPostalCodeRequired(bool $postalCodeRequired): void
  425.     {
  426.         $this->postalCodeRequired = $postalCodeRequired;
  427.     }
  429.     public function getCheckPostalCodePattern(): bool
  430.     {
  431.         return $this->checkPostalCodePattern;
  432.     }
  434.     public function setCheckPostalCodePattern(bool $checkPostalCodePattern): void
  435.     {
  436.         $this->checkPostalCodePattern = $checkPostalCodePattern;
  437.     }
  439.     public function getCheckAdvancedPostalCodePattern(): bool
  440.     {
  441.         return $this->checkAdvancedPostalCodePattern;
  442.     }
  444.     public function setCheckAdvancedPostalCodePattern(bool $checkAdvancedPostalCodePattern): void
  445.     {
  446.         $this->checkAdvancedPostalCodePattern = $checkAdvancedPostalCodePattern;
  447.     }
  449.     public function getAdvancedPostalCodePattern(): ?string
  450.     {
  451.         return $this->advancedPostalCodePattern;
  452.     }
  454.     public function setAdvancedPostalCodePattern(?string $advancedPostalCodePattern): void
  455.     {
  456.         $this->advancedPostalCodePattern = $advancedPostalCodePattern;
  457.     }
  459.     /**
  460.      * @return array<array<string, array<string, string>>>
  461.      */
  462.     public function getAddressFormat(): array
  463.     {
  464.         return $this->addressFormat;
  465.     }
  467.     /**
  468.      * @param array<array<string, array<string, string>>> $addressFormat
  469.      */
  470.     public function setAddressFormat(array $addressFormat): void
  471.     {
  472.         $this->addressFormat = $addressFormat;
  473.     }
  475.     public function setDefaultPostalCodePattern(?string $pattern): void
  476.     {
  477.         $this->defaultPostalCodePattern = $pattern;
  478.     }
  480.     public function getDefaultPostalCodePattern(): ?string
  481.     {
  482.         return $this->defaultPostalCodePattern;
  483.     }
  484. }