src/Entity/Order/Order.php line 40

  1. <?php
  3. /*
  4.  * This file is part of the Pellipop project.
  5.  *
  6.  * (c) Mobizel
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace App\Entity\Order;
  16. use App\Entity\Customer\Customer;
  17. use App\Entity\Geographical\Address;
  18. use App\Entity\IdentifiableTrait;
  19. use App\Entity\Printer\Printer;
  20. use App\OrderProductionStates;
  21. use App\OrderStates;
  22. use App\Repository\Order\OrderRepository;
  23. use Doctrine\Common\Collections\ArrayCollection;
  24. use Doctrine\Common\Collections\Collection;
  25. use Doctrine\ORM\Mapping as ORM;
  26. use Gedmo\Timestampable\Traits\TimestampableEntity;
  27. use Sylius\Component\Resource\Annotation\SyliusCrudRoutes;
  28. use Sylius\Component\Resource\Model\ResourceInterface;
  30. #[ORM\Entity(repositoryClass: OrderRepository::class)]
  31. #[ORM\Table(name: 'app_order')]
  32. #[SyliusCrudRoutes(alias: 'app.order', path: '/admin/orders', section: 'backend', templates: 'backend/order', grid: 'app_backend_order', only: ['index', 'show'], vars: [
  33.     'all' => [
  34.         'subheader' => 'app.ui.manage_your_orders',
  35.     ],
  36.     'index' => [
  37.         'icon' => 'cart',
  38.     ],
  39. ])]
  40. class Order implements ResourceInterface
  41. {
  42.     use IdentifiableTrait;
  43.     use TimestampableEntity;
  45.     #[ORM\ManyToOne(targetEntity: Customer::class, inversedBy: 'orders', cascade: ['persist'])]
  46.     #[ORM\JoinColumn(name: "customer_id", referencedColumnName: "id", onDelete: "CASCADE")]
  47.     private ?Customer $customer = null;
  49.     #[ORM\ManyToOne(targetEntity: Address::class, cascade:['persist', 'remove'])]
  50.     #[ORM\JoinColumn(name: "shipping_address_id", referencedColumnName: "id", onDelete: "CASCADE")]
  51.     private ?Address $shippingAddress = null;
  53.     #[ORM\Column(type: 'string')]
  54.     private string $state;
  56.     #[ORM\Column(type: 'datetime_immutable', nullable: true)]
  57.     private ?\DateTimeImmutable $checkoutCompletedAt = null;
  59.     #[ORM\Column(type: 'integer')]
  60.     private int $shippementAmount = 0;
  62.     #[ORM\Column(type: 'string', nullable: true)]
  63.     private ?string $number = null;
  65.     #[ORM\OneToMany(mappedBy: 'order', targetEntity: OrderItem::class, orphanRemoval: true, cascade:['persist', 'remove'])]
  66.     private Collection $orderItems;
  68.     #[ORM\Column(type: 'integer')]
  69.     private int $total = 0;
  71.     #[ORM\Column(length: 255)]
  72.     private ?string $productionState = null;
  74.     #[ORM\Column(nullable: true)]
  75.     private ?int $fujiId = null;
  77.     // Nullable malgré la contrainte NOT NULL déclarée par la migration Version20230531130423 :
  78.     // certaines lignes existantes ont NULL en base (ADD ... NOT NULL sur une table déjà peuplée,
  79.     // sans DEFAULT, peut laisser des lignes existantes à NULL selon le sql_mode MySQL/MariaDB au
  80.     // moment de l'ALTER). Sans ce ?, l'hydratation Doctrine de ces lignes lève un TypeError
  81.     // ("Cannot assign null to property ... of type array"). getFujiMessages()/addFujiMessage()
  82.     // gèrent le null en interne, donc rien ne change côté appelants.
  83.     #[ORM\Column(type: 'json', nullable: true)]
  84.     private ?array $fujiMessages = [];
  86.     // Workflow imprimeurs internes (App\Processor\Order\PrinterUploadPhotoProcessor), actif seulement
  87.     // si le paramètre printer_workflow_enabled est true. Coexiste avec fujiId/fujiMessages ci-dessus,
  88.     // qui restent utilisés par le workflow Fuji par défaut.
  89.     #[ORM\ManyToOne(targetEntity: Printer::class, inversedBy: 'orders')]
  90.     #[ORM\JoinColumn(name: 'printer_id', referencedColumnName: 'id', onDelete: 'SET NULL')]
  91.     private ?Printer $printer = null;
  93.     #[ORM\Column(type: 'text', nullable: true)]
  94.     private ?string $adminComment = null;
  96.     /** @var Collection<int, OrderAdminImage> */
  97.     #[ORM\OneToMany(mappedBy: 'order', targetEntity: OrderAdminImage::class, orphanRemoval: true, cascade: ['persist', 'remove'])]
  98.     private Collection $adminImages;
  100.     #[ORM\Column(type: 'boolean')]
  101.     private bool $isFromCode = false;
  103.     /** Total in cents (€) for direct payment. null when paid with credits. */
  104.     #[ORM\Column(type: 'integer', nullable: true)]
  105.     private ?int $totalAmountCents = null;
  107.     /** credits | direct | complement */
  108.     #[ORM\Column(type: 'string', length: 20, options: ['default' => 'credits'])]
  109.     private string $paymentMode = 'credits';
  111.     public function __construct()
  112.     {
  113.         $this->state = OrderStates::STATE_CART;
  114.         $this->productionState = OrderProductionStates::STATE_AWAITING;
  115.         $this->orderItems = new ArrayCollection();
  116.         $this->adminImages = new ArrayCollection();
  117.     }
  119.     /**
  120.      * Get the value of customer
  121.      *
  122.      * @return ?Customer
  123.      */
  124.     public function getCustomer(): ?Customer
  125.     {
  126.         return $this->customer;
  127.     }
  129.     /**
  130.      * Set the value of customer
  131.      *
  132.      * @return self
  133.      */
  134.     public function setCustomer(?Customer $customer): self
  135.     {
  136.         $this->customer = $customer;
  138.         return $this;
  139.     }
  141.     /**
  142.      * Get the value of shippingAddress
  143.      *
  144.      * @return ?Address
  145.      */
  146.     public function getShippingAddress(): ?Address
  147.     {
  148.         return $this->shippingAddress;
  149.     }
  151.     /**
  152.      * Set the value of shippingAddress
  153.      *
  154.      * @return self
  155.      */
  156.     public function setShippingAddress(?Address $address): self
  157.     {
  158.         $this->shippingAddress = $address;
  160.         return $this;
  161.     }
  163.     /**
  164.      * Get the value of state
  165.      *
  166.      * @return string
  167.      */
  168.     public function getState(): string
  169.     {
  170.         return $this->state;
  171.     }
  173.     /**
  174.      * Set the value of state
  175.      *
  176.      * @return self
  177.      */
  178.     public function setState(string $state): self
  179.     {
  180.         $this->state = $state;
  182.         return $this;
  183.     }
  185.     /**
  186.      * Get the value of checkoutCompletedAt
  187.      *
  188.      * @return ?\DateTimeImmutable
  189.      */
  190.     public function getCheckoutCompletedAt(): ?\DateTimeImmutable
  191.     {
  192.         return $this->checkoutCompletedAt;
  193.     }
  195.     /**
  196.      * Set the value of checkoutCompletedAt
  197.      *
  198.      * @return self
  199.      */
  200.     public function setCheckoutCompletedAt(?\DateTimeImmutable $checkoutCompletedAt): self
  201.     {
  202.         $this->checkoutCompletedAt = $checkoutCompletedAt;
  204.         return $this;
  205.     }
  207.     /**
  208.      * Get the value of shippementAmount
  209.      *
  210.      * @return int
  211.      */
  212.     public function getShippementAmount(): int
  213.     {
  214.         return $this->shippementAmount;
  215.     }
  217.     /**
  218.      * Set the value of shippementAmount
  219.      *
  220.      * @return self
  221.      */
  222.     public function setShippementAmount(int $shippementAmount): self
  223.     {
  224.         $this->shippementAmount = $shippementAmount;
  226.         return $this;
  227.     }
  229.     /**
  230.      * Get the value of number
  231.      *
  232.      * @return ?string
  233.      */
  234.     public function getNumber(): ?string
  235.     {
  236.         return $this->number;
  237.     }
  239.     /**
  240.      * Set the value of number
  241.      *
  242.      * @return self
  243.      */
  244.     public function setNumber(?string $number): self
  245.     {
  246.         $this->number = $number;
  248.         return $this;
  249.     }
  251.     /**
  252.      * @return Collection<int, OrderItem>
  253.      */
  254.     public function getOrderItems(): Collection
  255.     {
  256.         return $this->orderItems;
  257.     }
  259.     public function addOrderItem(OrderItem $orderItem): self
  260.     {
  261.         if (!$this->orderItems->contains($orderItem)) {
  262.             $this->orderItems->add($orderItem);
  263.             $orderItem->setOrder($this);
  264.         }
  266.         return $this;
  267.     }
  269.     public function removeOrderItem(OrderItem $orderItem): self
  270.     {
  271.         if ($this->orderItems->removeElement($orderItem)) {
  272.             if ($orderItem->getOrder() === $this) {
  273.                 $orderItem->setOrder(null);
  274.             }
  275.         }
  277.         return $this;
  278.     }
  280.     /**
  281.      * Get the value of total
  282.      *
  283.      * @return int
  284.      */
  285.     public function getTotal(): int
  286.     {
  287.         return $this->total;
  288.     }
  290.     /**
  291.      * Set the value of total
  292.      *
  293.      * @return self
  294.      */
  295.     public function setTotal(int $total): self
  296.     {
  297.         $this->total = $total;
  299.         return $this;
  300.     }
  302.     public function getProductsCost(): int
  303.     {
  304.         $cost = 0;
  306.         foreach ($this->getOrderItems() as $orderItem) {
  307.             $cost += $orderItem->getTotalPrice();
  308.         }
  310.         return $cost;
  311.     }
  313.     public function getFirstItem(): ?OrderItem
  314.     {
  315.         $orderItem = $this->getOrderItems()->first();
  316.         return ($orderItem instanceof OrderItem) ? $orderItem : null;
  317.     }
  319.     public function getFirstItemName(): ?string
  320.     {
  321.         return ($this->getFirstItem()) ? $this->getFirstItem()->getAlbumName() : null;
  322.     }
  324.     public function getFirstItemQuantity(): int
  325.     {
  326.         return ($this->getFirstItem()) ? $this->getFirstItem()->getQuantity() : 0;
  327.     }
  329.     public function getFirstItemPhotosCount(): int
  330.     {
  331.         return ($this->getFirstItem()) ? $this->getFirstItem()->getPhotosCount() : 0;
  332.     }
  334.     public function getFirstItemAlbumSize(): int
  335.     {
  336.         return ($this->getFirstItem()) ? $this->getFirstItem()->getProduct()->getAlbumSize() : 0;
  337.     }
  339.     public function getFirstItemMattePaper(): ?bool
  340.     {
  341.         return ($this->getFirstItem()) ? $this->getFirstItem()->getMattePaper() : null;
  342.     }
  344.     public function getFirstItemWithFrame(): ?bool
  345.     {
  346.         return ($this->getFirstItem()) ? $this->getFirstItem()->getWithFrame() : null;
  347.     }
  349.     public function getProductionState(): ?string
  350.     {
  351.         return $this->productionState;
  352.     }
  354.     public function setProductionState(string $productionState): self
  355.     {
  356.         $this->productionState = $productionState;
  358.         return $this;
  359.     }
  361.     public function getFujiId(): ?int
  362.     {
  363.         return $this->fujiId;
  364.     }
  366.     public function setFujiId(?int $fujiId): self
  367.     {
  368.         $this->fujiId = $fujiId;
  370.         return $this;
  371.     }
  373.     public function getFujiMessages(): array
  374.     {
  375.         return $this->fujiMessages ?? [];
  376.     }
  378.     public function addFujiMessage(string $fujiMessage): self
  379.     {
  380.         $this->fujiMessages ??= [];
  381.         $this->fujiMessages[] = $fujiMessage;
  383.         return $this;
  384.     }
  386.     public function getPrinter(): ?Printer
  387.     {
  388.         return $this->printer;
  389.     }
  391.     public function setPrinter(?Printer $printer): self
  392.     {
  393.         $this->printer = $printer;
  395.         return $this;
  396.     }
  398.     public function getAdminComment(): ?string
  399.     {
  400.         return $this->adminComment;
  401.     }
  403.     public function setAdminComment(?string $adminComment): self
  404.     {
  405.         $this->adminComment = $adminComment;
  407.         return $this;
  408.     }
  410.     /** @return Collection<int, OrderAdminImage> */
  411.     public function getAdminImages(): Collection
  412.     {
  413.         return $this->adminImages;
  414.     }
  416.     public function addAdminImage(OrderAdminImage $adminImage): self
  417.     {
  418.         if (!$this->adminImages->contains($adminImage)) {
  419.             $this->adminImages->add($adminImage);
  420.             $adminImage->setOrder($this);
  421.         }
  423.         return $this;
  424.     }
  426.     public function removeAdminImage(OrderAdminImage $adminImage): self
  427.     {
  428.         if ($this->adminImages->removeElement($adminImage)) {
  429.             if ($adminImage->getOrder() === $this) {
  430.                 $adminImage->setOrder(null);
  431.             }
  432.         }
  434.         return $this;
  435.     }
  437.     public function isFromCode(): bool
  438.     {
  439.         return $this->isFromCode;
  440.     }
  442.     public function setIsFromCode(bool $isFromCode): self
  443.     {
  444.         $this->isFromCode = $isFromCode;
  445.         return $this;
  446.     }
  448.     public function getTotalAmountCents(): ?int
  449.     {
  450.         return $this->totalAmountCents;
  451.     }
  453.     public function setTotalAmountCents(?int $totalAmountCents): self
  454.     {
  455.         $this->totalAmountCents = $totalAmountCents;
  456.         return $this;
  457.     }
  459.     public function getPaymentMode(): string
  460.     {
  461.         return $this->paymentMode;
  462.     }
  464.     public function setPaymentMode(string $paymentMode): self
  465.     {
  466.         $this->paymentMode = $paymentMode;
  467.         return $this;
  468.     }
  470.     public function isDirectPayment(): bool
  471.     {
  472.         return $this->paymentMode === 'direct' || $this->paymentMode === 'complement';
  473.     }
  474. }