src/Entity/PaymentPeriod.php line 17

  1. <?php
  3. namespace App\Entity;
  5. use App\Enum\CustomerClass;
  6. use App\Enum\EmployeeStatus;
  7. use App\Enum\RegionEnum;
  8. use App\Repository\PaymentPeriodRepository;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\Common\Collections\Criteria;
  12. use Doctrine\DBAL\Types\Types;
  13. use Doctrine\ORM\Mapping as ORM;
  14. use Gedmo\Timestampable\Traits\TimestampableEntity;
  16. #[ORM\Entity(repositoryClass: PaymentPeriodRepository::class)]
  17. class PaymentPeriod
  18. {
  19.     use TimestampableEntity;
  20.     #[ORM\Id]
  21.     #[ORM\GeneratedValue]
  22.     #[ORM\Column]
  23.     private ?int $id = null;
  25.     #[ORM\Column(type: Types::DATETIME_MUTABLE)]
  26.     private ?\DateTimeInterface $start = null;
  28.     #[ORM\Column(type: Types::DATETIME_MUTABLE)]
  29.     private ?\DateTimeInterface $end = null;
  31.     #[ORM\OneToMany(mappedBy: 'paymentPeriod', targetEntity: UserPaymentPeriod::class, cascade: ['REMOVE'], fetch: "EXTRA_LAZY")]
  32.     private Collection $userPaymentPeriods;
  34.     private $userFilter = null;
  35.     private $filteredUserPaymentPeriods = null;
  37.     #[ORM\ManyToOne(inversedBy: 'paymentPeriods')]
  38.     #[ORM\JoinColumn(nullable: false)]
  39.     private ?Year $year = null;
  41.     public function __construct()
  42.     {
  43.         $this->userPaymentPeriods = new ArrayCollection();
  44.     }
  46.     public function getId(): ?int
  47.     {
  48.         return $this->id;
  49.     }
  51.     public function getStart(): ?\DateTimeInterface
  52.     {
  53.         return $this->start;
  54.     }
  56.     public function setStart(\DateTimeInterface $start): self
  57.     {
  58.         $this->start = $start;
  60.         return $this;
  61.     }
  63.     public function getEnd(): ?\DateTimeInterface
  64.     {
  65.         return $this->end;
  66.     }
  68.     public function setEnd(\DateTimeInterface $end): self
  69.     {
  70.         $this->end = $end;
  72.         return $this;
  73.     }
  76.     public function __toString()
  77.     {
  78.         return $this->getStart()?->format('m-d-Y') . ' to ' . $this->getEnd()?->format('m-d-Y');
  79.     }
  81.     public function getUserPaymentPeriodsFiltered(array $filter = [])
  82.     {
  83.         if (count($filter)) {
  84.             // speeds up report generation
  85.             $ids = array_map(fn($u) => $u->getId(), $filter);
  86.             if ($ids == $this->userFilter) {
  87.                 return $this->filteredUserPaymentPeriods;
  88.             }
  89.             $this->userFilter = $ids;
  90.             $criteria = Criteria::create()->where(Criteria::expr()->in("user", $filter));
  91.             $filtered = $this->getUserPaymentPeriods()->matching($criteria);
  92.             $this->filteredUserPaymentPeriods = $filtered;
  93.             return $filtered;
  94.         }
  95.         else {
  96.             return $this->getUserPaymentPeriods();
  97.         }
  98.     }
  102.     /**
  103.      * @return Collection<int, UserPaymentPeriod>
  104.      */
  105.     public function getUserPaymentPeriods(array $filter = []): Collection
  106.     {
  107.         return $this->userPaymentPeriods;
  108.     }
  110.     public function addUserPaymentPeriod(UserPaymentPeriod $userPaymentPeriod): self
  111.     {
  112.         if (!$this->userPaymentPeriods->contains($userPaymentPeriod)) {
  113.             $this->userPaymentPeriods->add($userPaymentPeriod);
  114.             $userPaymentPeriod->setPaymentPeriod($this);
  115.         }
  117.         return $this;
  118.     }
  120.     public function removeUserPaymentPeriod(UserPaymentPeriod $userPaymentPeriod): self
  121.     {
  122.         if ($this->userPaymentPeriods->removeElement($userPaymentPeriod)) {
  123.             // set the owning side to null (unless already changed)
  124.             if ($userPaymentPeriod->getPaymentPeriod() === $this) {
  125.                 $userPaymentPeriod->setPaymentPeriod(null);
  126.             }
  127.         }
  129.         return $this;
  130.     }
  132.     public function sumRawSales(?RegionEnum $region = null, array $userFilter = [], array $customerClasses = [])
  133.     {
  134.         $amt = 0;
  135.         // enables passing [null] as empty
  136.         $userFilter = array_filter($userFilter);
  137.         foreach($this->getUserPaymentPeriodsFiltered($userFilter) as $upp) {
  139.             if ($region) {
  140.                 if ($upp->getUser()->getRegion() !== $region) {
  141.                     continue;
  142.                 }
  143.             }
  145.             foreach($upp->getOrders()->toArray() as $order) {
  146.                 if (count($customerClasses)) {
  147.                     if (!in_array($order->getCustomerGeneralClass(), $customerClasses)) {
  148.                         continue;
  149.                     }
  150.                     $amt += $order->getProductAmountInPennies();
  151.                 } else {
  152.                     $amt += $order->getProductAmountInPennies();
  154.                 }
  155.             }
  156.         }
  158.         $amt = $amt / 100.00;
  160.         return $amt;
  162.     }
  164.     public function sumCommissions(?RegionEnum $region = null, array $userFilter = [], array $customerClasses = [])
  165.     {
  167.         $amt = 0;
  168.         // enables passing [null] as empty
  169.         $userFilter = array_filter($userFilter);
  170.         foreach($this->getUserPaymentPeriodsFiltered($userFilter) as $upp) {
  172.             if ($region) {
  173.                 if ($upp->getUser()->getRegion() !== $region) {
  174.                     continue;
  175.                 }
  176.             }
  178.             foreach($upp->getCommissionResults()->toArray() as $commission) {
  179.                 if (count($customerClasses)) {
  180.                     if (!in_array($commission->getCreditResult()->getOriginalOrder()->getCustomerGeneralClass(), $customerClasses)) {
  181.                         continue;
  182.                     }
  183.                     $amt += $commission->getAmountInPennies();
  184.                 } else {
  185.                     $amt += $commission->getAmountInPennies();
  186.                 }
  187.             }
  188.         }
  190.         $amt = $amt / 100.00;
  192.         return $amt;
  194.     }
  196.     public function sumGuarantees(?RegionEnum $region = null, array $userFilter = [])
  197.     {
  198.         $amt = 0;
  199.         // enables passing [null] as empty
  200.         $userFilter = array_filter($userFilter);
  201.         foreach($this->getUserPaymentPeriodsFiltered($userFilter) as $upp) {
  203.             if ($region) {
  204.                 if ($upp->getUser()->getRegion() !== $region) {
  205.                     continue;
  206.                 }
  207.             }
  209.             foreach($upp->getGuaranteePayments()->toArray() as $guarantee) {
  210.                 $amt += $guarantee->getAmtInPennies();
  211.             }
  212.         }
  214.         $amt = $amt / 100.00;
  216.         return $amt;
  218.     }
  220.     public function sumTrueUps(?RegionEnum $region = null, array $userFilter = [])
  221.     {
  222.         $amt = 0;
  223.         // enables passing [null] as empty
  224.         $userFilter = array_filter($userFilter);
  225.         foreach($this->getUserPaymentPeriodsFiltered($userFilter) as $upp) {
  227.             if ($region) {
  228.                 if ($upp->getUser()->getRegion() !== $region) {
  229.                     continue;
  230.                 }
  231.             }
  233.             foreach($upp->getTrueUps()->toArray() as $trueUp) {
  234.                 $amt += $trueUp->getAmtInPennies();
  235.             }
  236.         }
  238.         $amt = $amt / 100.00;
  240.         return $amt;
  241.     }
  243.     public function sumManualCorrections(?RegionEnum $region = null, array $userFilter = [])
  244.     {
  245.         $amt = 0;
  246.         // enables passing [null] as empty
  247.         $userFilter = array_filter($userFilter);
  248.         foreach($this->getUserPaymentPeriodsFiltered($userFilter) as $upp) {
  250.             if ($region) {
  251.                 if ($upp->getUser()->getRegion() !== $region) {
  252.                     continue;
  253.                 }
  254.             }
  256.             foreach($upp->getTotalDues()->toArray() as $td) {
  257.                 $amt += $td->getManualCorrectionInPennies();
  258.             }
  259.         }
  261.         $amt = $amt / 100.00;
  263.         return $amt;
  264.     }
  266.     public function sumFinalTotals(?RegionEnum $region = null, array $userFilter = [])
  267.     {
  269.         $amt = 0;
  270.         // enables passing [null] as empty
  271.         $userFilter = array_filter($userFilter);
  272.         foreach($this->getUserPaymentPeriodsFiltered($userFilter) as $upp) {
  274.             if ($region) {
  275.                 if ($upp->getUser()->getRegion() !== $region) {
  276.                     continue;
  277.                 }
  278.             }
  280.             foreach($upp->getTotalDues()->toArray() as $td) {
  281.                 $amt += ($td->getAmtInPennies() + $td->getManualCorrectionInPennies());
  282.             }
  283.         }
  285.         $amt = $amt / 100.00;
  287.         return $amt;
  288.     }
  290.     public function getYear(): ?Year
  291.     {
  292.         return $this->year;
  293.     }
  295.     public function setYear(?Year $year): self
  296.     {
  297.         $this->year = $year;
  299.         return $this;
  300.     }
  303. }