src/Entity/Country.php line 39

Open in your IDE?
  1. <?php
  3. /**
  4.  * @author Leo BANNHOLTZER (contact@scaledev.fr)
  5.  * @copyright 2021 - ScaleDEV SAS, 12 RUE CHARLES MORET, 10120 ST ANDRE LES VERGERS
  6.  * @license commercial
  7.  */
  9. declare(strict_types=1);
  11. namespace App\Entity;
  13. use Symfony\Component\Uid\Uuid;
  14. use Doctrine\ORM\Mapping as ORM;
  15. use App\Entity\CountryTranslation;
  16. use App\Repository\CountryRepository;
  17. use Gedmo\Mapping\Annotation as Gedmo;
  18. use App\DoctrineExtensions\IsActiveEntity;
  19. use Doctrine\Common\Collections\Collection;
  20. use Doctrine\Common\Collections\ArrayCollection;
  21. use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
  22. use App\DoctrineExtensions\Timestampable\Traits\UserTimestampableEntity;
  23. use App\DoctrineExtensions\SoftDeleteable\Traits\UserSoftDeleteableEntity;
  25. /**
  26.  * @ORM\Entity(repositoryClass=CountryRepository::class)
  27.  * @Gedmo\TranslationEntity(class="App\Entity\CountryTranslation")
  28.  * @ORM\Table(name="country", indexes={
  29.  *  @ORM\Index(name="name", columns={"name"}),
  30.  *  @ORM\Index(name="iso_code", columns={"iso_code"}),
  31.  *  @ORM\Index(name="area_code", columns={"area_code"}),
  32.  *  @ORM\Index(name="is_active", columns={"is_active"}),
  33.  *  @ORM\Index(name="deleted_at", columns={"deleted_at"}),
  34.  *  @ORM\Index(name="created_at", columns={"created_at"}),
  35.  *  @ORM\Index(name="updated_at", columns={"updated_at"})
  36.  * })
  37.  * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false, hardDelete=false)
  38.  */
  39. class Country implements \JsonSerializable
  40. {
  41.     use UserTimestampableEntity;
  42.     use UserSoftDeleteableEntity;
  43.     use IsActiveEntity;
  45.     /**
  46.      * @ORM\Id
  47.      * @ORM\Column(type="uuid")
  48.      * @ORM\GeneratedValue(strategy="CUSTOM")
  49.      * @ORM\CustomIdGenerator(class=UuidGenerator::class)
  50.      */
  51.     private ?Uuid $id = null;
  53.     /**
  54.      * @ORM\ManyToOne(targetEntity=CountryZone::class, inversedBy="countries")
  55.      */
  56.     private ?CountryZone $country_zone;
  58.     /**
  59.      * @Gedmo\Translatable
  60.      * @ORM\Column(type="string", length=64)
  61.      */
  62.     private string $name;
  64.     /**
  65.      * @ORM\Column(type="string", length=3, nullable=true)
  66.      */
  67.     private ?string $iso_code;
  69.     /**
  70.      * @ORM\Column(type="string", length=10, nullable=true)
  71.      */
  72.     private ?string $area_code;
  74.     /**
  75.      * @ORM\OneToMany(targetEntity=CountryState::class, mappedBy="country", fetch="EXTRA_LAZY")
  76.      */
  77.     private Collection $countryStates;
  79.     /**
  80.      * @ORM\OneToMany(targetEntity=TaxRuleCountry::class, mappedBy="country", fetch="EXTRA_LAZY")
  81.      */
  82.     private Collection $taxRuleCountries;
  84.     /**
  85.      * @ORM\OneToMany(targetEntity=Context::class, mappedBy="country", fetch="EXTRA_LAZY")
  86.      */
  87.     private Collection $contexts;
  89.     /**
  90.      * @ORM\OneToMany(
  91.      *   targetEntity="CountryTranslation",
  92.      *   mappedBy="object",
  93.      *   cascade={"persist", "remove"},
  94.      *   fetch="EXTRA_LAZY"
  95.      * )
  96.      */
  97.     private Collection $translations;
  99.     /**
  100.      * @ORM\OneToMany(targetEntity=Establishment::class, mappedBy="country")
  101.      */
  102.     private ?Collection $establishments;
  104.     public function __construct()
  105.     {
  106.         $this->countryStates = new ArrayCollection();
  107.         $this->taxRuleCountries = new ArrayCollection();
  108.         $this->contexts = new ArrayCollection();
  109.         $this->translations = new ArrayCollection();
  110.         $this->establishments = new ArrayCollection();
  111.     }
  114.     /**
  115.      * @return Uuid|null
  116.      */
  117.     public function getId(): ?Uuid
  118.     {
  119.         return $this->id;
  120.     }
  122.     /**
  123.      * @return CountryZone|null
  124.      */
  125.     public function getCountryZone(): ?CountryZone
  126.     {
  127.         return $this->country_zone;
  128.     }
  130.     /**
  131.      * @param CountryZone|null $country_zone
  132.      * @return $this
  133.      */
  134.     public function setCountryZone(?CountryZone $country_zone): self
  135.     {
  136.         $this->country_zone = $country_zone;
  137.         return $this;
  138.     }
  140.     /**
  141.      * @return string
  142.      */
  143.     public function getName(): string
  144.     {
  145.         return $this->name;
  146.     }
  148.     /**
  149.      * @param string $name
  150.      * @return $this
  151.      */
  152.     public function setName(string $name): self
  153.     {
  154.         $this->name = $name;
  155.         return $this;
  156.     }
  158.     /**
  159.      * @return string|null
  160.      */
  161.     public function getIsoCode(): ?string
  162.     {
  163.         return $this->iso_code;
  164.     }
  166.     /**
  167.      * @param string|null $iso_code
  168.      * @return $this
  169.      */
  170.     public function setIsoCode(?string $iso_code): self
  171.     {
  172.         $this->iso_code = $iso_code;
  173.         return $this;
  174.     }
  176.     /**
  177.      * @return string|null
  178.      */
  179.     public function getAreaCode(): ?string
  180.     {
  181.         return $this->area_code;
  182.     }
  184.     /**
  185.      * @param string|null $area_code
  186.      * @return $this
  187.      */
  188.     public function setAreaCode(?string $area_code): self
  189.     {
  190.         $this->area_code = $area_code;
  191.         return $this;
  192.     }
  194.     /**
  195.      * @return Collection|CountryState[]
  196.      */
  197.     public function getCountryStates(): Collection
  198.     {
  199.         return $this->countryStates;
  200.     }
  202.     /**
  203.      * @return Collection|TaxRuleCountry[]
  204.      */
  205.     public function getTaxRuleCountries(): Collection
  206.     {
  207.         return $this->taxRuleCountries;
  208.     }
  210.     /**
  211.      * @return Collection|Context[]
  212.      */
  213.     public function getContexts(): Collection
  214.     {
  215.         return $this->contexts;
  216.     }
  218.     /**
  219.      * @param Context $context
  220.      * @return $this
  221.      */
  222.     public function addContext(Context $context): self
  223.     {
  224.         if (!$this->contexts->contains($context)) {
  225.             $this->contexts[] = $context;
  226.             $context->setCountry($this);
  227.         }
  228.         return $this;
  229.     }
  231.     /**
  232.      * @return Collection|CountryTranslation[]
  233.      */
  234.     public function getTranslations()
  235.     {
  236.         return $this->translations;
  237.     }
  239.     /**
  240.      * @param CountryTranslation $t
  241.      * @return $this
  242.      */
  243.     public function addTranslation(CountryTranslation $t): self
  244.     {
  245.         if (!$this->translations->contains($t)) {
  246.             $this->translations[] = $t;
  247.             $t->setObject($this);
  248.         }
  249.         return $this;
  250.     }
  252.     /**
  253.      * @return mixed
  254.      */
  255.     #[\ReturnTypeWillChange]
  256.     public function jsonSerialize()
  257.     {
  258.         return [
  259.             'id' => $this->id,
  260.             'name' => $this->name,
  261.             'country_zone' => $this->country_zone,
  262.             'iso_code' => $this->iso_code,
  263.             'countryStates' => $this->countryStates->toArray(),
  264.             'taxRuleCountries' => $this->taxRuleCountries->toArray(),
  265.             'contexts' => $this->contexts
  266.         ];
  267.     }
  269.     /**
  270.      * @return bool
  271.      */
  272.     public function isEU(): bool
  273.     {
  274.         $eu_countrycodes = [
  275.             'AT', 'BE', 'BG', 'CY', 'CZ', 'DE', 'DK', 'EE', 'EL',
  276.             'ES', 'FI', 'FR', 'GR', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV',
  277.             'MC', 'MT', 'NL', 'PL', 'PT', 'RO', 'SE', 'SI', 'SK'
  278.         ];
  279.         return in_array(strtoupper($this->iso_code), $eu_countrycodes);
  280.     }
  282.     /**
  283.      * @return Collection<int, Establishment>
  284.      */
  285.     public function getEstablishments(): Collection
  286.     {
  287.         return $this->establishments;
  288.     }
  290.     public function addEstablishment(Establishment $establishment): self
  291.     {
  292.         if (!$this->establishments->contains($establishment)) {
  293.             $this->establishments[] = $establishment;
  294.             $establishment->setCountry($this);
  295.         }
  297.         return $this;
  298.     }
  300.     public function removeEstablishment(Establishment $establishment): self
  301.     {
  302.         if ($this->establishments->removeElement($establishment)) {
  303.             // set the owning side to null (unless already changed)
  304.             if ($establishment->getCountry() === $this) {
  305.                 $establishment->setCountry(null);
  306.             }
  307.         }
  309.         return $this;
  310.     }
  311. }