src/Domain/Entity/StatisticLog/YearlyStatistic.php line 25

Open in your IDE?
  1. <?php
  3. namespace App\Domain\Entity\StatisticLog;
  5. use ApiPlatform\Metadata\ApiResource;
  6. use ApiPlatform\Metadata\Get;
  7. use ApiPlatform\Metadata\GetCollection;
  8. use App\Domain\Entity\Behavior\Identifiable;
  9. use Gedmo\Timestampable\Traits\Timestampable;
  10. use Gedmo\SoftDeleteable\Traits\SoftDeleteable;
  12. /**
  13.  * Class YearlyStatistic
  14.  *
  15.  * @package App\Domain\Entity\StatisticLog
  16.  */
  17. #[ApiResource(
  18.     operations: [
  19.         new Get(),
  20.         new GetCollection(),
  21.     ],
  22.     normalizationContext: ['groups' => ['yearly_stats_read']],
  23.     filters: ['yearlyStatistic.search_filter'],
  24. )]
  25. class YearlyStatistic
  26. {
  27.     use Identifiable;
  28.     use Timestampable;
  29.     use SoftDeleteable;
  31.     private int $year;
  32.     private int $totalRead = 0;
  33.     private int $totalReadList = 0;
  34.     private int $totalClick = 0;
  35.     private float $averageRead = 0.0;
  36.     private float $averageReadList = 0.0;
  37.     private float $averageClick = 0.0;
  38.     private string $entity;
  39.     private ?int $entityId = null;
  40.     public ?string $name;
  41.     public ?bool $isEntityPro = false;
  42.     private ?array $data = null;
  44.     public function __construct(
  45.         int $year,
  46.         string $entity,
  47.         ?int $entityId = null,
  48.         ?string $name = null,
  49.         ?bool $isEntityPro = null,
  50.         ?array $data = null
  51.     ) {
  52.         $this->year = $year;
  53.         $this->entity = $entity;
  54.         $this->entityId = $entityId;
  55.         $this->name = $name;
  56.         $this->isEntityPro = $isEntityPro;
  57.         $this->data = $data;
  58.     }
  60.     public function getYear(): int
  61.     {
  62.         return $this->year;
  63.     }
  65.     public function setYear(int $year): self
  66.     {
  67.         $this->year = $year;
  68.         return $this;
  69.     }
  71.     public function getTotalRead(): int
  72.     {
  73.         return $this->totalRead;
  74.     }
  76.     public function setTotalRead(int $totalRead): self
  77.     {
  78.         $this->totalRead = $totalRead;
  79.         return $this;
  80.     }
  82.     public function getTotalReadList(): int
  83.     {
  84.         return $this->totalReadList;
  85.     }
  87.     public function setTotalReadList(int $totalReadList): self
  88.     {
  89.         $this->totalReadList = $totalReadList;
  90.         return $this;
  91.     }
  93.     public function getTotalClick(): int
  94.     {
  95.         return $this->totalClick;
  96.     }
  98.     public function setTotalClick(int $totalClick): self
  99.     {
  100.         $this->totalClick = $totalClick;
  101.         return $this;
  102.     }
  104.     public function getAverageRead(): float
  105.     {
  106.         return $this->averageRead;
  107.     }
  109.     public function setAverageRead(float $averageRead): self
  110.     {
  111.         $this->averageRead = $averageRead;
  112.         return $this;
  113.     }
  115.     public function getAverageReadList(): float
  116.     {
  117.         return $this->averageReadList;
  118.     }
  120.     public function setAverageReadList(float $averageReadList): self
  121.     {
  122.         $this->averageReadList = $averageReadList;
  123.         return $this;
  124.     }
  126.     public function getAverageClick(): float
  127.     {
  128.         return $this->averageClick;
  129.     }
  131.     public function setAverageClick(float $averageClick): self
  132.     {
  133.         $this->averageClick = $averageClick;
  134.         return $this;
  135.     }
  137.     public function getEntity(): string
  138.     {
  139.         return $this->entity;
  140.     }
  142.     public function setEntity(string $entity): self
  143.     {
  144.         $this->entity = $entity;
  145.         return $this;
  146.     }
  148.     public function getEntityId(): ?int
  149.     {
  150.         return $this->entityId;
  151.     }
  153.     public function getName(): string
  154.     {
  155.         return $this->name;
  156.     }
  158.     public function setName(string $name): self
  159.     {
  160.         $this->name = $name;
  161.         return $this;
  162.     }
  164.     public function setEntityId(?int $entityId): self
  165.     {
  166.         $this->entityId = $entityId;
  167.         return $this;
  168.     }
  170.     public function getData(): ?array
  171.     {
  172.         return $this->data;
  173.     }
  175.     public function setData(?array $data): self
  176.     {
  177.         $this->data = $data;
  178.         return $this;
  179.     }
  181.     public function incrementRead(int $amount = 1): self
  182.     {
  183.         $this->totalRead += $amount;
  184.         return $this;
  185.     }
  187.     public function incrementReadList(int $amount = 1): self
  188.     {
  189.         $this->totalReadList += $amount;
  190.         return $this;
  191.     }
  193.     public function incrementClick(int $amount = 1): self
  194.     {
  195.         $this->totalClick += $amount;
  196.         return $this;
  197.     }
  199.     public function updateAverages(int $monthsInYear = 12): void
  200.     {
  201.         $this->averageRead = $this->totalRead / $monthsInYear;
  202.         $this->averageReadList = $this->totalReadList / $monthsInYear;
  203.         $this->averageClick = $this->totalClick / $monthsInYear;
  204.     }
  206.     /**
  207.      * Reset all totals and averages to zero
  208.      */
  209.     public function resetStatistics(): void
  210.     {
  211.         $this->totalRead = 0;
  212.         $this->totalReadList = 0;
  213.         $this->totalClick = 0;
  214.         $this->averageRead = 0.0;
  215.         $this->averageReadList = 0.0;
  216.         $this->averageClick = 0.0;
  217.     }
  219.     public function isEntityPro(): ?bool
  220.     {
  221.         return $this->isEntityPro;
  222.     }
  224.     public function setIsEntityPro(?bool $isEntityPro): self
  225.     {
  226.         $this->isEntityPro = $isEntityPro;
  227.         return $this;
  228.     }
  229. }