src/Entity/Tuk.php line 16

  1. <?php
  3. namespace App\Entity;
  5. use App\Repository\TukRepository;
  6. use Doctrine\ORM\Mapping as ORM;
  8. /**
  9.  * A tuk-tuk. This is the entity that carries a live GPS position: the driver's
  10.  * phone pings its coordinates here, and the passenger's map draws them.
  11.  *
  12.  * @ORM\Entity(repositoryClass=TukRepository::class)
  13.  * @ORM\Table(name="tuk")
  14.  * @ORM\HasLifecycleCallbacks()
  15.  */
  16. class Tuk
  17. {
  18.     public const STATUS_OFFLINE   = 'offline';   // driver not working
  19.     public const STATUS_AVAILABLE = 'available'; // free, shown to passengers
  20.     public const STATUS_BUSY      = 'busy';      // on a tour
  22.     public const STATUSES = [
  23.         self::STATUS_OFFLINE,
  24.         self::STATUS_AVAILABLE,
  25.         self::STATUS_BUSY,
  26.     ];
  28.     /**
  29.      * A position older than this is stale: the driver closed the app or lost
  30.      * signal, so the tuk must not be offered to passengers.
  31.      */
  32.     public const PING_TIMEOUT_SECONDS = 60;
  34.     /**
  35.      * @ORM\Id
  36.      * @ORM\GeneratedValue
  37.      * @ORM\Column(type="integer")
  38.      */
  39.     private ?int $id = null;
  41.     /**
  42.      * Owning side of the one-to-one. A tuk with no driver is parked.
  43.      * @ORM\OneToOne(targetEntity=Driver::class, inversedBy="tuk")
  44.      * @ORM\JoinColumn(nullable=true, unique=true, onDelete="SET NULL")
  45.      */
  46.     private ?Driver $driver = null;
  48.     /**
  49.      * Fleet code shown to passengers, e.g. "TNT-01".
  50.      * @ORM\Column(type="string", length=20, unique=true)
  51.      */
  52.     private string $code;
  54.     /**
  55.      * @ORM\Column(type="string", length=20, nullable=true)
  56.      */
  57.     private ?string $plateNumber = null;
  59.     /**
  60.      * Hex paint colour of the vehicle, used for its map marker.
  61.      * @ORM\Column(type="string", length=7, options={"default": "#E8A020"})
  62.      */
  63.     private string $color = '#E8A020';
  65.     /**
  66.      * @ORM\Column(type="integer", options={"default": 3})
  67.      */
  68.     private int $seats = 3;
  70.     /**
  71.      * @ORM\Column(type="string", length=500, nullable=true)
  72.      */
  73.     private ?string $photo = null;
  75.     /**
  76.      * One of self::STATUSES.
  77.      * @ORM\Column(type="string", length=10, options={"default": "offline"})
  78.      */
  79.     private string $status = self::STATUS_OFFLINE;
  81.     /**
  82.      * @ORM\Column(type="decimal", precision=10, scale=7, nullable=true)
  83.      */
  84.     private ?float $latitude = null;
  86.     /**
  87.      * @ORM\Column(type="decimal", precision=10, scale=7, nullable=true)
  88.      */
  89.     private ?float $longitude = null;
  91.     /**
  92.      * Direction of travel in degrees (0 = north), so the marker can point.
  93.      * @ORM\Column(type="smallint", nullable=true)
  94.      */
  95.     private ?int $heading = null;
  97.     /**
  98.      * When the driver's phone last reported a position.
  99.      * @ORM\Column(type="datetime_immutable", nullable=true)
  100.      */
  101.     private ?\DateTimeImmutable $lastPingAt = null;
  103.     /**
  104.      * @ORM\Column(type="boolean", options={"default": true})
  105.      */
  106.     private bool $isActive = true;
  108.     /**
  109.      * @ORM\Column(type="datetime_immutable")
  110.      */
  111.     private \DateTimeImmutable $createdAt;
  113.     /**
  114.      * @ORM\Column(type="datetime_immutable", nullable=true)
  115.      */
  116.     private ?\DateTimeImmutable $updatedAt = null;
  118.     public function __construct()
  119.     {
  120.         $this->createdAt = new \DateTimeImmutable();
  121.     }
  123.     /**
  124.      * @ORM\PreUpdate()
  125.      */
  126.     public function onPreUpdate(): void
  127.     {
  128.         $this->updatedAt = new \DateTimeImmutable();
  129.     }
  131.     public function getId(): ?int
  132.     {
  133.         return $this->id;
  134.     }
  136.     public function getDriver(): ?Driver
  137.     {
  138.         return $this->driver;
  139.     }
  141.     public function setDriver(?Driver $driver): self
  142.     {
  143.         $this->driver = $driver;
  145.         // Keep the inverse side in sync so Driver::getTuk() works on objects
  146.         // that were changed in this request but not yet reloaded.
  147.         if ($driver !== null && $driver->getTuk() !== $this) {
  148.             $driver->setTuk($this);
  149.         }
  151.         return $this;
  152.     }
  154.     public function getCode(): string
  155.     {
  156.         return $this->code;
  157.     }
  159.     public function setCode(string $code): self
  160.     {
  161.         $this->code = $code;
  162.         return $this;
  163.     }
  165.     public function getPlateNumber(): ?string
  166.     {
  167.         return $this->plateNumber;
  168.     }
  170.     public function setPlateNumber(?string $plateNumber): self
  171.     {
  172.         $this->plateNumber = $plateNumber;
  173.         return $this;
  174.     }
  176.     public function getColor(): string
  177.     {
  178.         return $this->color;
  179.     }
  181.     public function setColor(string $color): self
  182.     {
  183.         $this->color = $color;
  184.         return $this;
  185.     }
  187.     public function getSeats(): int
  188.     {
  189.         return $this->seats;
  190.     }
  192.     public function setSeats(int $seats): self
  193.     {
  194.         $this->seats = $seats;
  195.         return $this;
  196.     }
  198.     public function getPhoto(): ?string
  199.     {
  200.         return $this->photo;
  201.     }
  203.     public function setPhoto(?string $photo): self
  204.     {
  205.         $this->photo = $photo;
  206.         return $this;
  207.     }
  209.     public function getStatus(): string
  210.     {
  211.         return $this->status;
  212.     }
  214.     public function setStatus(string $status): self
  215.     {
  216.         if (!in_array($status, self::STATUSES, true)) {
  217.             throw new \InvalidArgumentException(sprintf(
  218.                 'Invalid status "%s". Allowed: %s',
  219.                 $status,
  220.                 implode(', ', self::STATUSES)
  221.             ));
  222.         }
  223.         $this->status = $status;
  224.         return $this;
  225.     }
  227.     public function getLatitude(): ?float
  228.     {
  229.         return $this->latitude;
  230.     }
  232.     public function setLatitude(?float $latitude): self
  233.     {
  234.         $this->latitude = $latitude;
  235.         return $this;
  236.     }
  238.     public function getLongitude(): ?float
  239.     {
  240.         return $this->longitude;
  241.     }
  243.     public function setLongitude(?float $longitude): self
  244.     {
  245.         $this->longitude = $longitude;
  246.         return $this;
  247.     }
  249.     public function getHeading(): ?int
  250.     {
  251.         return $this->heading;
  252.     }
  254.     public function setHeading(?int $heading): self
  255.     {
  256.         $this->heading = $heading === null ? null : (($heading % 360) + 360) % 360;
  257.         return $this;
  258.     }
  260.     public function getLastPingAt(): ?\DateTimeImmutable
  261.     {
  262.         return $this->lastPingAt;
  263.     }
  265.     public function setLastPingAt(?\DateTimeImmutable $lastPingAt): self
  266.     {
  267.         $this->lastPingAt = $lastPingAt;
  268.         return $this;
  269.     }
  271.     /**
  272.      * Record a GPS fix from the driver's phone.
  273.      */
  274.     public function ping(float $latitude, float $longitude, ?int $heading = null): self
  275.     {
  276.         $this->latitude   = $latitude;
  277.         $this->longitude  = $longitude;
  278.         $this->lastPingAt = new \DateTimeImmutable();
  280.         if ($heading !== null) {
  281.             $this->setHeading($heading);
  282.         }
  284.         return $this;
  285.     }
  287.     public function isActive(): bool
  288.     {
  289.         return $this->isActive;
  290.     }
  292.     public function setIsActive(bool $isActive): self
  293.     {
  294.         $this->isActive = $isActive;
  295.         return $this;
  296.     }
  298.     public function getCreatedAt(): \DateTimeImmutable
  299.     {
  300.         return $this->createdAt;
  301.     }
  303.     public function getUpdatedAt(): ?\DateTimeImmutable
  304.     {
  305.         return $this->updatedAt;
  306.     }
  308.     // ── Derived state ────────────────────────────────────────────────────
  310.     /**
  311.      * True when the last GPS ping is recent enough to trust.
  312.      */
  313.     public function isOnline(): bool
  314.     {
  315.         if ($this->status === self::STATUS_OFFLINE || $this->lastPingAt === null) {
  316.             return false;
  317.         }
  319.         $age = (new \DateTimeImmutable())->getTimestamp() - $this->lastPingAt->getTimestamp();
  321.         return $age <= self::PING_TIMEOUT_SECONDS;
  322.     }
  324.     /**
  325.      * Can a passenger book this tuk right now?
  326.      */
  327.     public function isBookable(): bool
  328.     {
  329.         return $this->isActive
  330.             && $this->status === self::STATUS_AVAILABLE
  331.             && $this->latitude !== null
  332.             && $this->longitude !== null
  333.             && $this->driver !== null
  334.             && $this->isOnline();
  335.     }
  337.     public function __toString(): string
  338.     {
  339.         return $this->code ?? '';
  340.     }
  341. }