src/Entity/Location/City.php line 27

Open in your IDE?
  1. <?php
  2. /**
  3.  * Created by simpson <simpsonwork@gmail.com>
  4.  * Date: 2019-03-19
  5.  * Time: 17:12
  6.  */
  8. namespace App\Entity\Location;
  10. use AngelGamez\TranslatableBundle\Entity\TranslatableValue;
  11. //use ApiPlatform\Core\Annotation\ApiResource;
  12. use App\Repository\CityRepository;
  13. use Doctrine\Common\Collections\Collection;
  14. use Nelmio\ApiDocBundle\Model\Model;
  15. use Nelmio\ApiDocBundle\ModelDescriber\SelfDescribingModelInterface;
  16. use OpenApi\Annotations\Schema;
  17. use Symfony\Component\Serializer\Annotation\Groups;
  18. use Doctrine\Common\Collections\ArrayCollection;
  19. use Doctrine\ORM\Mapping as ORM;
  20. use Doctrine\ORM\Mapping\Index;
  21. use OpenApi\Attributes as OA;
  23. #[ORM\Table(name: 'cities')]
  24. #[Index(name: 'idx_uri_identity', columns: ['uri_identity'])]
  25. #[ORM\Entity(repositoryClass: CityRepository::class)]
  26. #[ORM\Cache(usage: 'NONSTRICT_READ_WRITE', region: 'geoposition')]
  27. class City implements SelfDescribingModelInterface
  28. {
  29.     const GROUP_MEGALOPOLIS = 1;
  30.     const GROUP_MOSCOW_REGION = 2;
  31.     const PRICE_CATEGORY_1 = 1;
  32.     const PRICE_CATEGORY_2 = 2;
  33.     const PRICE_CATEGORY_3 = 3;
  34.     const PRICE_CATEGORY_4 = 4;
  35.     const PRICE_CATEGORY_5 = 5;
  37.     #[ORM\Id]
  38.     #[ORM\Column(name: 'id', type: 'integer')]
  39.     #[ORM\GeneratedValue(strategy: 'AUTO')]
  40.     #[Groups(['preview', 'listing'])]
  41.     protected int $id;
  43.     #[ORM\Column(name: 'name', type: 'translatable')]
  44.     #[Groups(['preview', 'listing'])]
  45.     protected TranslatableValue $name;
  47.     #[ORM\Column(name: 'uri_identity', type: 'string', length: 128)]
  48.     #[Groups(['preview', 'listing'])]
  49.     protected string $uriIdentity;
  51.     #[ORM\Column(name: 'country_code', type: 'string', length: 2)]
  52.     #[Groups(['preview', 'listing'])]
  53.     protected string $countryCode;
  55.     #[ORM\Column(name: 'city_group', type: 'smallint', nullable: true)]
  56.     #[Groups('listing')]
  57.     protected ?int $cityGroup;
  59.     #[ORM\Column(name: 'city_price_category', type: 'smallint', nullable: true)]
  60.     protected ?int $cityPriceCategory = null;
  62.     /** @var County[] */
  63.     #[ORM\OneToMany(targetEntity: County::class, mappedBy: 'city')]
  64.     #[ORM\Cache(usage: 'READ_ONLY', region: 'geoposition')]
  65.     protected Collection $counties;
  67.     /** @var District[] */
  68.     #[ORM\OneToMany(targetEntity: District::class, mappedBy: 'city')]
  69.     #[ORM\Cache(usage: 'READ_ONLY', region: 'geoposition')]
  70.     protected Collection $districts;
  72.     /** @var Station[] */
  73.     #[ORM\OneToMany(targetEntity: Station::class, mappedBy: 'city')]
  74.     #[ORM\OrderBy(['name' => 'ASC'])]
  75.     #[ORM\Cache(usage: 'READ_ONLY', region: 'geoposition')]
  76.     protected Collection $stations;
  78.     #[ORM\Embedded(class: MapCoordinate::class, columnPrefix: false)]
  79.     #[Groups('listing')]
  80.     protected ?MapCoordinate $mapCoordinate;
  82.     #[ORM\Column(name: 'timezone', type: 'string', length: 6, nullable: true)]
  83.     #[Groups('listing')]
  84.     protected ?string $timezone;
  86.     /**
  87.      * Региональное разделение городов
  88.      * Например: мск+МО и спб+ЛО
  89.      */
  90.     #[ORM\Column(name: 'region', type: 'string', length: 128, nullable: true)]
  91.     #[Groups(['listing', 'preview'])]
  92.     protected ?string $region;
  94.     public function __construct(TranslatableValue $name, string $uriIdentity, string $countryCode, ?int $cityGroup = null, ?MapCoordinate $mapCoordinate = null, ?string $region = null)
  95.     {
  96.         $this->rename($name, $uriIdentity);
  97.         $this->relocate($countryCode, $cityGroup, $mapCoordinate, $region);
  99.         $this->counties = new ArrayCollection();
  100.         $this->districts = new ArrayCollection();
  101.         $this->stations = new ArrayCollection();
  102.     }
  104.     /**
  105.      * @param City|string $cityOrUriIdentity Instance of City class or URI identity string
  106.      */
  107.     public function equals(City|string $cityOrUriIdentity): bool
  108.     {
  109.         if ($cityOrUriIdentity instanceof City) {
  110.             return $cityOrUriIdentity->id === $this->id;
  111.         } elseif (is_string($cityOrUriIdentity)) {
  112.             return $cityOrUriIdentity === $this->uriIdentity;
  113.         }
  115.         throw new \InvalidArgumentException(__METHOD__.' can accept either string with URI identity or instance of App\\Entity\\Location\\City class.');
  116.     }
  118.     public function rename(TranslatableValue $name, string $uriIdentity): void
  119.     {
  120.         $this->name = $name;
  121.         $this->uriIdentity = $uriIdentity;
  122.     }
  124.     public function relocate(string $countryCode, ?int $cityGroup, ?MapCoordinate $mapCoordinate, ?string $region = null): void
  125.     {
  126.         $this->countryCode = $countryCode;
  127.         $this->cityGroup = $cityGroup;
  128.         $this->mapCoordinate = $mapCoordinate;
  129.         $this->region = $region;
  130.     }
  132.     public function getId(): int
  133.     {
  134.         return $this->id;
  135.     }
  137.     public function getName(): TranslatableValue
  138.     {
  139.         return $this->name;
  140.     }
  142.     public function getUriIdentity(): string
  143.     {
  144.         return $this->uriIdentity;
  145.     }
  147.     public function getCountryCode(): string
  148.     {
  149.         return $this->countryCode;
  150.     }
  152.     public function getCityGroup(): ?int
  153.     {
  154.         return $this->cityGroup;
  155.     }
  157.     public function getCityPriceCategory(): ?int
  158.     {
  159.         return $this->cityPriceCategory;
  160.     }
  162.     public function setCityPriceCategory(?int $cityPriceCategory): void
  163.     {
  164.         $this->cityPriceCategory = $cityPriceCategory;
  165.     }
  167.     /**
  168.      * @return County[]
  169.      */
  170.     public function getCounties(): Collection
  171.     {
  172.         return $this->counties;
  173.     }
  175.     public function hasCounty(County $county): bool
  176.     {
  177.         return $this->counties->contains($county);
  178.     }
  180.     /**
  181.      * @return District[]
  182.      */
  183.     public function getDistricts(): Collection
  184.     {
  185.         return $this->districts;
  186.     }
  188.     public function hasDistrict(District $district): bool
  189.     {
  190.         return $this->districts->contains($district);
  191.     }
  193.     /**
  194.      * @return Station[]
  195.      */
  196.     public function getStations(): Collection
  197.     {
  198.         return $this->stations;
  199.     }
  201.     public function hasStation(Station $station): bool
  202.     {
  203.         return $this->stations->contains($station);
  204.     }
  206.     //TODO return type?
  207.     public function getMapCoordinate(): ?MapCoordinate
  208.     {
  209.         return $this->mapCoordinate;
  210.     }
  212.     public function getTimezone(): ?string
  213.     {
  214.         return $this->timezone;
  215.     }
  217.     public function setTimezone(string $timezone): void
  218.     {
  219.         $this->timezone = $timezone;
  220.     }
  222.     public function getRegion(): ?string
  223.     {
  224.         return $this->region;
  225.     }
  227.     public function setRegion(?string $region): void
  228.     {
  229.         $this->region = $region;
  230.     }
  232.     /**
  233.      * @inheritDoc
  234.      */
  235.     public function __toString(): string
  236.     {
  237.         return (string) $this->name;
  238.     }
  240.     public static function describe(Schema $schema, Model $model): void
  241.     {
  242.         $schema->type = 'object';
  243.         $schema->properties = [
  244.             new OA\Property(property: 'id', type: 'integer'),
  245.             new OA\Property(property: 'name', type: 'object'),
  246.             new OA\Property(property: 'uriIdentity', type: 'string'),
  247.             new OA\Property(property: 'countryCode', type: 'string'),
  248.             new OA\Property(property: 'cityGroup', type: 'integer', nullable: true),
  249.             new OA\Property(property: 'mapCoordinate', properties: [new OA\Property(property: 'latitude', type: 'string'), new OA\Property(property: 'longitude', type: 'string')], type: 'object', nullable: true),
  250.             new OA\Property(property: 'timezone', type: 'string', nullable: true),
  251.             new OA\Property(property: 'region', description: 'Региональное разделение городов', type: 'string', nullable: true),
  252.         ];
  253.         $schema->description = 'City model';
  254.         $schema->example = [
  255.             'id' => 1,
  256.             'name' => ['ru' => 'Москва', 'en' => 'Moscow'],
  257.             'uriIdentity' => 'moscow',
  258.             'countryCode' => 'RU',
  259.             'cityGroup' => 1,
  260.             'mapCoordinate' => ['latitude' => '55.755825', 'longitude' => '37.617298'],
  261.             'timezone' => '+03:00',
  262.             'region' => 'moscow',
  263.         ];
  264.     }
  265. }