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.     public function __construct(TranslatableValue $name, string $uriIdentity, string $countryCode, ?int $cityGroup = null, ?MapCoordinate $mapCoordinate = null)
  87.     {
  88.         $this->rename($name, $uriIdentity);
  89.         $this->relocate($countryCode, $cityGroup, $mapCoordinate);
  91.         $this->counties = new ArrayCollection();
  92.         $this->districts = new ArrayCollection();
  93.         $this->stations = new ArrayCollection();
  94.     }
  96.     /**
  97.      * @param City|string $cityOrUriIdentity Instance of City class or URI identity string
  98.      */
  99.     public function equals(City|string $cityOrUriIdentity): bool
  100.     {
  101.         if ($cityOrUriIdentity instanceof City) {
  102.             return $cityOrUriIdentity->id === $this->id;
  103.         } elseif (is_string($cityOrUriIdentity)) {
  104.             return $cityOrUriIdentity === $this->uriIdentity;
  105.         }
  107.         throw new \InvalidArgumentException(__METHOD__.' can accept either string with URI identity or instance of App\\Entity\\Location\\City class.');
  108.     }
  110.     public function rename(TranslatableValue $name, string $uriIdentity): void
  111.     {
  112.         $this->name = $name;
  113.         $this->uriIdentity = $uriIdentity;
  114.     }
  116.     public function relocate(string $countryCode, ?int $cityGroup, ?MapCoordinate $mapCoordinate): void
  117.     {
  118.         $this->countryCode = $countryCode;
  119.         $this->cityGroup = $cityGroup;
  120.         $this->mapCoordinate = $mapCoordinate;
  121.     }
  123.     public function getId(): int
  124.     {
  125.         return $this->id;
  126.     }
  128.     public function getName(): TranslatableValue
  129.     {
  130.         return $this->name;
  131.     }
  133.     public function getUriIdentity(): string
  134.     {
  135.         return $this->uriIdentity;
  136.     }
  138.     public function getCountryCode(): string
  139.     {
  140.         return $this->countryCode;
  141.     }
  143.     public function getCityGroup(): ?int
  144.     {
  145.         return $this->cityGroup;
  146.     }
  148.     public function getCityPriceCategory(): ?int
  149.     {
  150.         return $this->cityPriceCategory;
  151.     }
  153.     public function setCityPriceCategory(?int $cityPriceCategory): void
  154.     {
  155.         $this->cityPriceCategory = $cityPriceCategory;
  156.     }
  158.     /**
  159.      * @return County[]
  160.      */
  161.     public function getCounties(): Collection
  162.     {
  163.         return $this->counties;
  164.     }
  166.     public function hasCounty(County $county): bool
  167.     {
  168.         return $this->counties->contains($county);
  169.     }
  171.     /**
  172.      * @return District[]
  173.      */
  174.     public function getDistricts(): Collection
  175.     {
  176.         return $this->districts;
  177.     }
  179.     public function hasDistrict(District $district): bool
  180.     {
  181.         return $this->districts->contains($district);
  182.     }
  184.     /**
  185.      * @return Station[]
  186.      */
  187.     public function getStations(): Collection
  188.     {
  189.         return $this->stations;
  190.     }
  192.     public function hasStation(Station $station): bool
  193.     {
  194.         return $this->stations->contains($station);
  195.     }
  197.     //TODO return type?
  198.     public function getMapCoordinate(): ?MapCoordinate
  199.     {
  200.         return $this->mapCoordinate;
  201.     }
  203.     public function getTimezone(): ?string
  204.     {
  205.         return $this->timezone;
  206.     }
  208.     public function setTimezone(string $timezone): void
  209.     {
  210.         $this->timezone = $timezone;
  211.     }
  213.     /**
  214.      * @inheritDoc
  215.      */
  216.     public function __toString(): string
  217.     {
  218.         return (string) $this->name;
  219.     }
  221.     public static function describe(Schema $schema, Model $model): void
  222.     {
  223.         $schema->type = 'object';
  224.         $schema->properties = [
  225.             new OA\Property(property: 'id', type: 'integer'),
  226.             new OA\Property(property: 'name', type: 'object'),
  227.             new OA\Property(property: 'uriIdentity', type: 'string'),
  228.             new OA\Property(property: 'countryCode', type: 'string'),
  229.             new OA\Property(property: 'cityGroup', type: 'integer', nullable: true),
  230.             new OA\Property(property: 'mapCoordinate', properties: [new OA\Property(property: 'latitude', type: 'string'), new OA\Property(property: 'longitude', type: 'string')], type: 'object', nullable: true),
  231.             new OA\Property(property: 'timezone', type: 'string', nullable: true),
  232.         ];
  233.         $schema->description = 'City model';
  234.         $schema->example = [
  235.             'id' => 1,
  236.             'name' => ['ru' => 'Москва', 'en' => 'Moscow'],
  237.             'uriIdentity' => 'moscow',
  238.             'countryCode' => 'RU',
  239.             'cityGroup' => 1,
  240.             'mapCoordinate' => ['latitude' => '55.755825', 'longitude' => '37.617298'],
  241.             'timezone' => '+03:00',
  242.         ];
  243.     }
  244. }