src/Entity/Gauge/Gauge.php line 32

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Gauge;
  5. use App\Entity\Building\Building;
  6. use App\Entity\Building\Sector;
  7. use App\Entity\ContractPrice\Contract;
  8. use App\Entity\ContractPrice\ContractItemType;
  9. use App\Entity\Event\Event;
  10. use App\Entity\Extension\BlameableTrait;
  11. use App\Entity\Extension\DisabledReasonTrait;
  12. use App\Entity\Extension\DisabledTrait;
  13. use App\Entity\Extension\HistoricalInterface;
  14. use App\Entity\Extension\ItemsWithHistoryTrait;
  15. use App\Entity\Extension\TimestampableTrait;
  16. use App\Entity\File;
  17. use App\Entity\Import\DataImport;
  18. use App\Entity\PriceDecision\Distributor;
  19. use App\Repository\Gauge\GaugeRepository;
  20. use App\Utils\Dataset;
  21. use App\Utils\GaugeType;
  22. use App\Utils\Period;
  23. use App\Utils\Units;
  24. use Doctrine\Common\Collections\ArrayCollection;
  25. use Doctrine\Common\Collections\Collection;
  26. use Doctrine\ORM\Mapping as ORM;
  28. /**
  29. * @ORM\Entity(repositoryClass=GaugeRepository::class)
  30. * @ORM\Table(name="gauges")
  31. */
  32. class Gauge
  33. {
  34. /**
  35. * @var int|null
  36. * @ORM\Id()
  37. * @ORM\GeneratedValue()
  38. * @ORM\Column(type="integer")
  39. */
  40. private ?int $id = null;
  42. /**
  43. * values are defined above in class definition
  44. * @var int
  45. * @ORM\Column(type="smallint", nullable=false)
  46. */
  47. private int $level;
  49. /**
  50. * values are defined in App\Utils\GaugeType::TYPE_...
  51. * @var int
  52. * @ORM\Column(type="smallint", nullable=false)
  53. */
  54. private int $type;
  56. /**
  57. * values are defined in App\Utils\GaugeType::SOURCE...
  58. * @var int|null
  59. * @ORM\Column(type="smallint", nullable=true)
  60. */
  61. private ?int $primarySource = null;
  63. /**
  64. * @var string|null
  65. * @ORM\Column(type="string", nullable=true)
  66. */
  67. private ?string $primarySourceOther = null;
  69. /**
  70. * @var Building
  71. * @ORM\ManyToOne(targetEntity="App\Entity\Building\Building", inversedBy="gauges")
  72. * @ORM\JoinColumn(name="building_id", referencedColumnName="id", nullable=false)
  73. */
  74. private Building $building;
  76. /**
  77. * @var Collection|Gauge[]
  78. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\Gauge", mappedBy="parent", cascade={"persist"})
  79. */
  80. protected $children;
  82. /**
  83. * @var Collection|File[]
  84. *
  85. * @ORM\ManyToMany(targetEntity="App\Entity\File", mappedBy="gauges")
  86. */
  87. private $files;
  89. /**
  90. * @var Gauge|null
  91. * @ORM\ManyToOne(targetEntity="App\Entity\Gauge\Gauge", inversedBy="children")
  92. * @ORM\JoinColumn(name="parent", referencedColumnName="id", nullable=true)
  93. */
  94. protected ?Gauge $parent = null;
  96. /**
  97. * @var string
  98. * @ORM\Column(type="string", nullable=false)
  99. */
  100. private string $name = '';
  102. /**
  103. * Path to generated QR code image linking to gauge readings
  104. * @var string|null
  105. * @ORM\Column(type="string", name="qr_code_path", nullable=true)
  106. */
  107. private ?string $qrCodePath = null;
  109. /**
  110. * values are defined in App\Utils\Dataset::MEASUREMENT_PARAM...
  111. * @var int
  112. * @ORM\Column(type="smallint", nullable=false)
  113. */
  114. private int $measurementTarget = GaugeType::MEASUREMENT_TARGET_CONSUMPTION;
  116. /**
  117. * indicator if is allowed remote readings
  118. * @var bool
  119. * @ORM\Column(type="boolean")
  120. */
  121. private bool $remote = false;
  123. /**
  124. * @var bool
  125. * @ORM\Column(type="boolean", nullable=false, options={"default" : 0})
  126. */
  127. private bool $remoteAsPrimary = false;
  129. /**
  130. * Php stan exception: this is right entity mapping by documentation. In constructor is solved not-nullable properties.
  131. * https://github.com/phpstan/phpstan-doctrine/issues/97
  132. *
  133. * @ORM\OneToOne(targetEntity="App\Entity\Gauge\GaugeProperties", mappedBy="gauge", cascade={"all"})
  134. */
  135. private GaugeProperties $properties; // @phpstan-ignore-line
  137. /**
  138. * @var Collection|GaugeRate[]
  139. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugeRate", mappedBy="gauge", cascade={"all"})
  140. */
  141. private $rates;
  143. /**
  144. * @var Collection|ShareOfGauges[]
  145. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\ShareOfGauges", mappedBy="gauge", cascade={"all"})
  146. */
  147. private $shares;
  149. /**
  150. * @var Collection|GaugePhaseAndBreaker[]
  151. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugePhaseAndBreaker", mappedBy="gauge", cascade={"all"})
  152. */
  153. private $phaseAndBreaker;
  155. /**
  156. * @var Collection|GaugeHeatingPower[]
  157. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugeHeatingPower", mappedBy="gauge", cascade={"all"})
  158. */
  159. private $heatingPower;
  161. /**
  162. * @var Collection|GaugeUnitPrice[]
  163. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugeUnitPrice", mappedBy="gauge", cascade={"all"})
  164. * @ORM\OrderBy({"validFrom" = "ASC"})
  165. */
  166. private $unitPrice;
  168. /**
  169. * @var Collection|GaugePriceSupplyPoint[]
  170. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugePriceSupplyPoint", mappedBy="gauge", cascade={"all"})
  171. */
  172. private $priceSupplyPoint;
  174. /**
  175. * @var GaugeRemoteProperties|null
  176. * @ORM\OneToOne(targetEntity="App\Entity\Gauge\GaugeRemoteProperties", mappedBy="gauge", cascade={"all"})
  177. */
  178. private ?GaugeRemoteProperties $remoteProperties;
  180. /**
  181. * @var File|null
  182. * @ORM\ManyToOne(targetEntity="App\Entity\File", inversedBy="gaugePhotos")
  183. * @ORM\JoinColumn(nullable=true)
  184. */
  185. private ?File $photo = null;
  187. /**
  188. * @var Distributor|null
  189. * @ORM\ManyToOne(targetEntity="App\Entity\PriceDecision\Distributor")
  190. * @ORM\JoinColumn(name="el_dictributor_id", referencedColumnName="id", nullable=true)
  191. */
  192. private ?Distributor $electricityDistributor = null;
  194. /**
  195. * @var Collection|GaugePurpose[]
  196. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugePurpose", mappedBy="gauge", cascade={"all"})
  197. */
  198. private $purposes;
  200. /**
  201. * @var Collection|GaugeReading[]
  202. *
  203. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugeReading", mappedBy="gauge")
  204. */
  205. private $readings;
  207. /**
  208. * @var Collection|Invoice[]
  209. *
  210. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\Invoice", mappedBy="gauge")
  211. */
  212. private $invoices;
  214. /**
  215. * @var Collection|Event[]
  216. *
  217. * @ORM\ManyToMany(targetEntity="App\Entity\Event\Event", mappedBy="gauges", cascade={"persist"})
  218. */
  219. private $events;
  221. /**
  222. * @var Collection|GaugeInvoiceUnit[]
  223. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugeInvoiceUnit", mappedBy="gauge", cascade={"all"})
  224. */
  225. private $invoiceUnits;
  227. /**
  228. * this attribute sets if data can be showed in output after gauge is disabled
  229. * @var \bool
  230. *
  231. * @ORM\Column(name="show_in_output", type="boolean", nullable=false, options={"default": 1})
  232. */
  233. protected bool $showInOutput = true;
  235. /**
  236. * values are defined in App\Utils\Dataset::CONSUMPTION_IN...
  237. * @var int|null
  238. * @ORM\Column(type="smallint", nullable=true)
  239. */
  240. private ?int $dataInResults = Dataset::CONSUMPTION_IN_RESULTS_ON;
  242. /**
  243. * @var Collection|ConsumptionLimit[]
  244. * @ORM\ManyToMany(targetEntity="App\Entity\Gauge\ConsumptionLimit", mappedBy="gauges", cascade={"persist"})
  245. */
  246. private $consumptionLimits;
  248. /**
  249. * @var \DateTime|null
  250. *
  251. * @ORM\Column(type="datetime", nullable=true)
  252. */
  253. private ?\DateTime $lastSentNotificationAt;
  255. /**
  256. * @var DataImport|null
  257. * @ORM\ManyToOne(targetEntity="App\Entity\Import\DataImport", inversedBy="gauges")
  258. * @ORM\JoinColumn(nullable=true)
  259. */
  260. private ?DataImport $import = null;
  262. /**
  263. * @var Collection|Contract[]|null
  264. * @ORM\ManyToMany(targetEntity=Contract::class, mappedBy="gauges")
  265. */
  266. private $contracts;
  268. use BlameableTrait;
  269. use TimestampableTrait;
  270. use ItemsWithHistoryTrait;
  271. use DisabledTrait;
  272. use DisabledReasonTrait;
  274. public function __construct()
  275. {
  276. $this->type = GaugeType::TYPE_ELECTRICITY_METER;
  277. $this->level = GaugeType::LEVEL_MAIN;
  278. $this->setProperties(new GaugeProperties($this));
  279. $this->remoteProperties = null;
  280. $this->children = new ArrayCollection();
  281. $this->files = new ArrayCollection();
  282. $this->rates = new ArrayCollection();
  283. $this->phaseAndBreaker = new ArrayCollection();
  284. $this->heatingPower = new ArrayCollection();
  285. $this->unitPrice = new ArrayCollection();
  286. $this->priceSupplyPoint = new ArrayCollection();
  287. $this->readings = new ArrayCollection();
  288. $this->purposes = new ArrayCollection();
  289. $this->invoiceUnits = new ArrayCollection();
  290. $this->contracts = new ArrayCollection();
  291. }
  293. /**
  294. * @return int|null
  295. */
  296. public function getId(): ?int
  297. {
  298. return $this->id;
  299. }
  301. /**
  302. * @param int|null $id
  303. * @return Gauge
  304. */
  305. public function setId(?int $id): Gauge
  306. {
  307. $this->id = $id;
  308. return $this;
  309. }
  311. /**
  312. * @return int
  313. */
  314. public function getLevel(): int
  315. {
  316. return $this->level;
  317. }
  319. /**
  320. * @param int $level
  321. * @return Gauge
  322. */
  323. public function setLevel(int $level): Gauge
  324. {
  325. $this->level = $level;
  326. return $this;
  327. }
  329. /**
  330. * @return int
  331. */
  332. public function getType(): int
  333. {
  334. return $this->type;
  335. }
  337. /**
  338. * @param int $type
  339. * @return Gauge
  340. */
  341. public function setType(int $type): Gauge
  342. {
  343. $this->type = $type;
  344. return $this;
  345. }
  348. /**
  349. * @return Building
  350. */
  351. public function getBuilding(): Building
  352. {
  353. return $this->building;
  354. }
  356. /**
  357. * @param Building $building
  358. * @return Gauge
  359. */
  360. public function setBuilding(Building $building): Gauge
  361. {
  362. $this->building = $building;
  363. return $this;
  364. }
  366. /**
  367. * @return Gauge[]|Collection
  368. */
  369. public function getChildren()
  370. {
  371. return $this->children;
  372. }
  374. /**
  375. * @return Gauge|null
  376. */
  377. public function getParent(): ?Gauge
  378. {
  379. return $this->parent;
  380. }
  382. /**
  383. * @param Gauge|null $parent
  384. * @return Gauge
  385. */
  386. public function setParent(?Gauge $parent): Gauge
  387. {
  388. $this->parent = $parent;
  389. return $this;
  390. }
  392. /**
  393. * @return string
  394. */
  395. public function getName(): string
  396. {
  397. return $this->name;
  398. }
  400. /**
  401. * @param string $name
  402. * @return Gauge
  403. */
  404. public function setName(string $name): Gauge
  405. {
  406. $this->name = $name;
  407. return $this;
  408. }
  410. /**
  411. * @return string|null
  412. */
  413. public function getQrCodePath(): ?string
  414. {
  415. return $this->qrCodePath;
  416. }
  418. /**
  419. * @param string|null $qrCodePath
  420. * @return $this
  421. */
  422. public function setQrCodePath(?string $qrCodePath): self
  423. {
  424. $this->qrCodePath = $qrCodePath;
  425. return $this;
  426. }
  428. /**
  429. * @return GaugeProperties
  430. */
  431. public function getProperties(): GaugeProperties
  432. {
  433. return $this->properties;
  434. }
  436. /**
  437. * @param GaugeProperties $properties
  438. * @return Gauge
  439. */
  440. public function setProperties(GaugeProperties $properties): Gauge
  441. {
  442. $this->properties = $properties;
  444. return $this;
  445. }
  447. /**
  448. * @return Collection|File[]
  449. */
  450. public function getFiles(): Collection
  451. {
  452. return $this->files;
  453. }
  455. /**
  456. * @param File $file
  457. * @return $this
  458. */
  459. public function addFile(File $file): self
  460. {
  461. if (!$this->files->contains($file)) {
  462. $file->addGauge($this);
  463. $this->files->add($file);
  464. }
  466. return $this;
  467. }
  469. /**
  470. * @return int|null
  471. */
  472. public function getPrimarySource(): ?int
  473. {
  474. return $this->primarySource;
  475. }
  477. /**
  478. * @param int|null $primarySource
  479. * @return Gauge
  480. */
  481. public function setPrimarySource(?int $primarySource): Gauge
  482. {
  483. $this->primarySource = $primarySource;
  484. return $this;
  485. }
  487. /**
  488. * @return string|null
  489. */
  490. public function getPrimarySourceOther(): ?string
  491. {
  492. return $this->primarySourceOther;
  493. }
  495. /**
  496. * @param string|null $primarySourceOther
  497. * @return Gauge
  498. */
  499. public function setPrimarySourceOther(?string $primarySourceOther): Gauge
  500. {
  501. $this->primarySourceOther = $primarySourceOther;
  502. return $this;
  503. }
  505. /**
  506. * @param File $file
  507. * @return $this
  508. */
  509. public function removeFile(File $file): self
  510. {
  511. if ($this->files->contains($file)) {
  512. $this->files->removeElement($file);
  513. $file->removeGauge($this);
  514. }
  516. return $this;
  517. }
  519. /**
  520. * kontrola zda je měřidlo podružné
  521. * @return bool
  522. */
  523. public function isSecondary(): bool
  524. {
  525. if ($this->getLevel() === GaugeType::LEVEL_SECONDARY && $this->getParent() !== null) {
  526. return true;
  527. }
  528. return false;
  529. }
  531. /**
  532. * kontrola zda je měřidlo hlavní
  533. * @return bool
  534. */
  535. public function isMain(): bool
  536. {
  537. return $this->getLevel() === GaugeType::LEVEL_MAIN;
  538. }
  540. /**
  541. * @return string
  542. */
  543. public function __toString(): string
  544. {
  545. return $this->getName();
  546. }
  548. /**
  549. * @return File|null
  550. */
  551. public function getPhoto(): ?File
  552. {
  553. return $this->photo;
  554. }
  556. /**
  557. * @param File|null $photo
  558. * @return Gauge
  559. */
  560. public function setPhoto(?File $photo): Gauge
  561. {
  562. $this->photo = $photo;
  564. if ($photo !== null) {
  565. $photo->addGauge($this);
  566. }
  568. return $this;
  569. }
  571. /**
  572. * @return GaugeRate[]|Collection
  573. */
  574. public function getRates()
  575. {
  576. return $this->rates;
  577. }
  579. /**
  580. * @param GaugeRate[]|Collection $rates
  581. * @return Gauge
  582. */
  583. public function setRates($rates)
  584. {
  585. $this->rates = $rates;
  586. return $this;
  587. }
  589. /**
  590. * @param GaugeRate $rate
  591. * @return Gauge
  592. */
  593. public function addRate(GaugeRate $rate): Gauge
  594. {
  595. $rate->setGauge($this);
  596. $this->rates->add($rate);
  597. return $this;
  598. }
  600. /**
  601. * @return GaugePhaseAndBreaker[]|Collection
  602. */
  603. public function getPhaseAndBreaker(): Collection
  604. {
  605. return $this->phaseAndBreaker;
  606. }
  608. /**
  609. * @param GaugePhaseAndBreaker[]|Collection $phaseAndBreaker
  610. * @return Gauge
  611. */
  612. public function setPhaseAndBreaker($phaseAndBreaker): Gauge
  613. {
  614. $this->phaseAndBreaker = $phaseAndBreaker;
  615. return $this;
  616. }
  618. /**
  619. * @param GaugePhaseAndBreaker $phaseAndBreaker
  620. * @return Gauge
  621. */
  622. public function addPhaseAndBreaker(GaugePhaseAndBreaker $phaseAndBreaker): Gauge
  623. {
  624. $phaseAndBreaker->setGauge($this);
  625. $this->phaseAndBreaker->add($phaseAndBreaker);
  626. return $this;
  627. }
  629. /**
  630. * @return GaugeHeatingPower[]|Collection
  631. */
  632. public function getHeatingPower()
  633. {
  634. return $this->heatingPower;
  635. }
  637. /**
  638. * @param GaugeHeatingPower[]|Collection $heatingPower
  639. * @return Gauge
  640. */
  641. public function setHeatingPower($heatingPower): Gauge
  642. {
  643. $this->heatingPower = $heatingPower;
  644. return $this;
  645. }
  647. /**
  648. * @param GaugeHeatingPower $heatingPower
  649. * @return Gauge
  650. */
  651. public function addHeatingPower(GaugeHeatingPower $heatingPower): Gauge
  652. {
  653. $heatingPower->setGauge($this);
  654. $this->heatingPower->add($heatingPower);
  655. return $this;
  656. }
  658. /**
  659. * @return GaugeUnitPrice[]|Collection
  660. */
  661. public function getUnitPrice()
  662. {
  663. return $this->unitPrice;
  664. }
  666. /**
  667. * @param GaugeUnitPrice[]|Collection $unitPrice
  668. * @return Gauge
  669. */
  670. public function setUnitPrice($unitPrice): Gauge
  671. {
  672. $this->unitPrice = $unitPrice;
  673. return $this;
  674. }
  676. /**
  677. * @param GaugeUnitPrice $unitPrice
  678. * @return $this
  679. */
  680. public function addUnitPrice(GaugeUnitPrice $unitPrice): Gauge
  681. {
  682. $unitPrice->setGauge($this);
  683. $this->unitPrice->add($unitPrice);
  684. return $this;
  685. }
  687. /**
  688. * @return GaugePriceSupplyPoint[]|Collection
  689. */
  690. public function getPriceSupplyPoint(): Collection
  691. {
  692. return $this->priceSupplyPoint;
  693. }
  695. /**
  696. * @param GaugePriceSupplyPoint[]|Collection $priceSupplyPoint
  697. * @return Gauge
  698. */
  699. public function setPriceSupplyPoint($priceSupplyPoint): Gauge
  700. {
  701. $this->priceSupplyPoint = $priceSupplyPoint;
  702. return $this;
  703. }
  705. /**
  706. * @param GaugePriceSupplyPoint $priceSupplyPoint
  707. * @return $this
  708. */
  709. public function addPriceSupplyPoint(GaugePriceSupplyPoint $priceSupplyPoint): Gauge
  710. {
  711. $priceSupplyPoint->setGauge($this);
  712. $this->priceSupplyPoint->add($priceSupplyPoint);
  713. return $this;
  714. }
  716. /**
  717. * @return GaugeRemoteProperties|null
  718. */
  719. public function getRemoteProperties(): ?GaugeRemoteProperties
  720. {
  721. return $this->remoteProperties;
  722. }
  724. /**
  725. * @param GaugeRemoteProperties|null $remoteProperties
  726. * @return Gauge
  727. */
  728. public function setRemoteProperties(?GaugeRemoteProperties $remoteProperties): Gauge
  729. {
  730. $this->remoteProperties = $remoteProperties;
  731. return $this;
  732. }
  734. /**
  735. * @param int $mediumType
  736. * @param \DateTime|null $date
  737. * @return HistoricalInterface|GaugeUnitPrice|mixed|null
  738. */
  739. public function getCurrentUnitPrice(int $mediumType, ?\DateTime $date = null)
  740. {
  741. if ($date === null) {
  742. $date = new \DateTime();
  743. }
  745. $current = null;
  746. foreach ($this->getUnitPrice() as $item) {
  747. if ($item->getValidFrom() <= $date
  748. && $mediumType === $item->getMedium()
  749. && (
  750. !$current instanceof GaugeUnitPrice
  751. || $item->getValidFrom() > $current->getValidFrom()
  752. )
  753. ) {
  754. $current = $item;
  755. }
  756. }
  758. return $current;
  759. }
  761. /**
  762. * @return bool
  763. */
  764. public function isRemote(): bool
  765. {
  766. return $this->remote;
  767. }
  769. /**
  770. * @param bool $remote
  771. * @return Gauge
  772. */
  773. public function setRemote(bool $remote): Gauge
  774. {
  775. $this->remote = $remote;
  776. return $this;
  777. }
  779. /**
  780. * @return GaugeReading[]|Collection
  781. */
  782. public function getReadings()
  783. {
  784. return $this->readings;
  785. }
  787. /**
  788. * @return bool
  789. */
  790. public function isElectricityMeter(): bool
  791. {
  792. return $this->isType(GaugeType::TYPE_ELECTRICITY_METER);
  793. }
  795. /**
  796. * @return bool
  797. */
  798. public function isGasometter(): bool
  799. {
  800. return $this->isType(GaugeType::TYPE_GASOMETER);
  801. }
  803. /**
  804. * @param int $type
  805. * @return bool
  806. */
  807. public function isType(int $type): bool
  808. {
  809. return $this->getType() === $type;
  810. }
  812. /**
  813. * @return bool
  814. */
  815. public function canHaveReadings(): bool
  816. {
  817. return $this->getLevel() !== GaugeType::LEVEL_FICTIVE && $this->getType() !== GaugeType::TYPE_OTHER_FUELS;
  818. }
  820. /**
  821. * @return bool
  822. */
  823. public function canHaveInvoices(): bool
  824. {
  825. return true;
  826. }
  828. public function hasProduction(): bool
  829. {
  830. return in_array($this->getMeasurementTarget(), [GaugeType::MEASUREMENT_TARGET_PRODUCTION, GaugeType::MEASUREMENT_TARGET_CONSUMPTION_DELIVERY], true);
  831. }
  833. /**
  834. * @return GaugePurpose[]|Collection
  835. */
  836. public function getPurposes(): Collection
  837. {
  838. return $this->purposes;
  839. }
  841. /**
  842. * @param GaugePurpose[]|Collection $purposes
  843. * @return Gauge
  844. */
  845. public function setPurposes($purposes): Gauge
  846. {
  847. $this->purposes = $purposes;
  848. return $this;
  849. }
  851. /**
  852. * @param GaugePurpose $gaugePurpose
  853. * @return Gauge
  854. */
  855. public function addPurpose(GaugePurpose $gaugePurpose): Gauge
  856. {
  857. if (!$this->purposes->contains($gaugePurpose)) {
  858. $gaugePurpose->setGauge($this);
  859. $this->purposes->add($gaugePurpose);
  860. }
  861. return $this;
  862. }
  864. /**
  865. * @return int
  866. */
  867. public function getMeasurementTarget(): int
  868. {
  869. return $this->measurementTarget;
  870. }
  872. /**
  873. * @param int $measurementTarget
  874. * @return Gauge
  875. */
  876. public function setMeasurementTarget(int $measurementTarget): Gauge
  877. {
  878. $this->measurementTarget = $measurementTarget;
  879. return $this;
  880. }
  882. /**
  883. * @param int $purposeConst
  884. * @return GaugePurpose|null
  885. */
  886. public function getPurposeObject(int $purposeConst): ?GaugePurpose
  887. {
  888. foreach ($this->getPurposes() as $gaugePurpose) {
  889. if ($gaugePurpose->getPurpose() === $purposeConst) {
  890. return $gaugePurpose;
  891. }
  892. }
  894. return null;
  895. }
  897. /**
  898. * @return GaugePurpose|null
  899. */
  900. public function getPurposeFirst(): ?GaugePurpose
  901. {
  902. if ($this->purposes->count() > 0) {
  903. return $this->purposes->first();
  904. }
  906. return null;
  907. }
  909. /**
  910. * @param int $purposeConst
  911. * @return GaugePurpose
  912. */
  913. public function getPurposeNewOrExistObject(int $purposeConst): GaugePurpose
  914. {
  915. $gaugePurpose = $this->getPurposeObject($purposeConst);
  916. if ($gaugePurpose === null) {
  917. $gaugePurpose = new GaugePurpose();
  918. $gaugePurpose->setPurpose($purposeConst);
  919. $gaugePurpose->setGauge($this);
  920. }
  922. return $gaugePurpose;
  923. }
  925. /**
  926. * @return Invoice[]|Collection
  927. */
  928. public function getInvoices(): Collection
  929. {
  930. return $this->invoices;
  931. }
  933. /**
  934. * @param Invoice[]|Collection $invoices
  935. * @return Gauge
  936. */
  937. public function setInvoices($invoices): Gauge
  938. {
  939. $this->invoices = $invoices;
  940. return $this;
  941. }
  943. /**
  944. * @param Invoice $invoice
  945. * @return Gauge
  946. */
  947. public function addInvoice(Invoice $invoice): Gauge
  948. {
  949. $this->invoices[] = $invoice;
  950. return $this;
  951. }
  953. /**
  954. * @param \DateTime|null $date
  955. * @return int
  956. */
  957. public function getInvoiceUnit(?\DateTime $date = null): int
  958. {
  959. $invUnitObj = $this->getCurrent('invoiceUnits', $date, $this->getInvoiceUnits());
  961. if ($invUnitObj instanceof GaugeInvoiceUnit) {
  962. return $invUnitObj->getUnit();
  963. }
  965. return Units::getDefaultUnitByGaugeType($this->getType());
  966. }
  968. /**
  969. * @return Event[]|Collection
  970. */
  971. public function getEvents()
  972. {
  973. return $this->events;
  974. }
  976. /**
  977. * @param Event[]|Collection $events
  978. * @return Gauge
  979. */
  980. public function setEvents($events): Gauge
  981. {
  982. $this->events = $events;
  983. return $this;
  984. }
  986. public function getSector(): Sector
  987. {
  988. return $this->getBuilding()->getSector();
  989. }
  991. /**
  992. * @return ShareOfGauges[]|Collection
  993. */
  994. public function getShares()
  995. {
  996. return $this->shares;
  997. }
  999. /**
  1000. * @param ShareOfGauges[]|Collection $shares
  1001. * @return Gauge
  1002. */
  1003. public function setShares($shares): Gauge
  1004. {
  1005. $this->shares = $shares;
  1006. return $this;
  1007. }
  1009. /**
  1010. * @return array
  1011. */
  1012. public function toArray(): array
  1013. {
  1014. return [
  1015. 'id' => $this->getId(),
  1016. 'name' => $this->getName()
  1017. ];
  1018. }
  1020. /**
  1021. * @return bool
  1022. */
  1023. public function isElectricityWholesale():bool
  1024. {
  1025. if (
  1026. $this->getType() === GaugeType::TYPE_ELECTRICITY_METER &&
  1027. in_array($this->getProperties()->getConsumptionType(), [Dataset::CONSUMPTION_TYPE_WHOLESALE_VN, Dataset::CONSUMPTION_TYPE_WHOLESALE_VVN], true)
  1028. ) {
  1029. return true;
  1030. }
  1032. return false;
  1033. }
  1035. /**
  1036. * @return bool
  1037. */
  1038. public function isForceLowTariff():bool
  1039. {
  1040. return $this->getProperties()->getForceLowTariff() === true;
  1041. }
  1043. /**
  1044. * @return bool
  1045. */
  1046. public function isForceSpecialTariff():bool
  1047. {
  1048. return $this->getProperties()->getForceSpecialTariff() === true;
  1049. }
  1051. /**
  1052. * @return GaugeInvoiceUnit[]|Collection
  1053. */
  1054. public function getInvoiceUnits(): Collection
  1055. {
  1056. return $this->invoiceUnits;
  1057. }
  1059. /**
  1060. * @param GaugeInvoiceUnit $item
  1061. * @return $this
  1062. */
  1063. public function addInvoiceUnit(GaugeInvoiceUnit $item): self
  1064. {
  1065. $item->setGauge($this);
  1066. $this->invoiceUnits->add($item);
  1068. return $this;
  1069. }
  1071. /**
  1072. * @return Distributor|null
  1073. */
  1074. public function getElectricityDistributor(): ?Distributor
  1075. {
  1076. return $this->electricityDistributor;
  1077. }
  1079. /**
  1080. * @param Distributor|null $electricityDistributor
  1081. * @return Gauge
  1082. */
  1083. public function setElectricityDistributor(?Distributor $electricityDistributor): Gauge
  1084. {
  1085. $this->electricityDistributor = $electricityDistributor;
  1086. return $this;
  1087. }
  1089. /**
  1090. * @return string|null
  1091. */
  1092. public function getCustomerName() :?string
  1093. {
  1094. if ($this->properties->getCustomerName() === null) {
  1095. return $this->building->getOwner();
  1096. }
  1098. return $this->properties->getCustomerName();
  1099. }
  1101. /**
  1102. * @return GaugePurpose|null
  1103. */
  1104. public function getConsumptionPurpose(): ?GaugePurpose
  1105. {
  1106. foreach ($this->purposes as $gPurpose) {
  1107. if ($gPurpose->getPurpose() === GaugePurpose::PURPOSE_CONSUMPTION) {
  1108. return $gPurpose;
  1109. }
  1110. }
  1112. return null;
  1113. }
  1115. /**
  1116. * @return bool|null
  1117. */
  1118. public function getShowInOutput(): ?bool
  1119. {
  1120. return $this->showInOutput;
  1121. }
  1123. /**
  1124. * @param bool|null $showInOutput
  1125. * @return self
  1126. */
  1127. public function setShowInOutput(?bool $showInOutput): self
  1128. {
  1129. $this->showInOutput = $showInOutput;
  1130. return $this;
  1131. }
  1133. public function getImport(): ?DataImport
  1134. {
  1135. return $this->import;
  1136. }
  1138. public function setImport(?DataImport $import): Gauge
  1139. {
  1140. $this->import = $import;
  1141. return $this;
  1142. }
  1144. /**
  1145. * @return int
  1146. */
  1147. public function getConsumptionInResultsRatio(): int
  1148. {
  1149. $inResultsSettings = $this->getDataInResults();
  1151. if ($inResultsSettings === Dataset::CONSUMPTION_IN_RESULTS_OFF) {
  1152. return 0;
  1153. }
  1155. if ($inResultsSettings === Dataset::CONSUMPTION_IN_RESULTS_TAKE_OFF) {
  1156. return - 1;
  1157. }
  1159. return 1;
  1160. }
  1162. /**
  1163. * @return int
  1164. */
  1165. public function getCostInResultsRatio(): int
  1166. {
  1167. $costInResults = $this->getProperties()->getCostsInResults();
  1169. if ($costInResults === Dataset::COSTS_IN_RESULTS_OFF) {
  1170. return 0;
  1171. }
  1173. if ($costInResults === Dataset::COSTS_IN_RESULTS_TAKE_OFF) {
  1174. return - 1;
  1175. }
  1177. return 1;
  1178. }
  1180. /**
  1181. * @return bool
  1182. */
  1183. public function hasParentFromSameBuilding():bool
  1184. {
  1185. if ($this->getParent() === null) {
  1186. return false;
  1187. }
  1189. return $this->getParent()->getBuilding()->getId() === $this->getBuilding()->getId();
  1190. }
  1192. /**
  1193. * @param bool|null $client
  1194. * @return string
  1195. */
  1196. public function getNameWithBuilding(?bool $client = null): string
  1197. {
  1198. if ($client === true) {
  1199. return sprintf('%s - %s', $this->getBuilding()->getClient()->getName(), $this->getNameWithBuilding());
  1200. }
  1202. return sprintf('%s - %s', $this->getBuilding()->getName(), $this->getName());
  1203. }
  1205. /**
  1206. * @return int|string|null
  1207. */
  1208. public function getTdd()
  1209. {
  1210. if ($this->isElectricityMeter()) {
  1211. return $this->getProperties()->getTddEl();
  1212. }
  1214. if ($this->isGasometter()) {
  1215. return $this->getProperties()->getTdd();
  1216. }
  1218. return null;
  1219. }
  1221. /**
  1222. * method returns all allowed segments by all gauge purposes
  1223. * @return void
  1224. */
  1225. public function getSegments(): array
  1226. {
  1227. $segments = [];
  1229. foreach ($this->purposes as $gPurpose) {
  1230. $segments = array_merge($segments, $gPurpose->getSegments());
  1231. }
  1233. return $segments;
  1234. }
  1236. public function getDataInResults(): ?int
  1237. {
  1238. return $this->dataInResults;
  1239. }
  1241. public function setDataInResults(?int $dataInResults): Gauge
  1242. {
  1243. $this->dataInResults = $dataInResults;
  1244. return $this;
  1245. }
  1247. public function hasConsumptionUsage(int $usage): bool
  1248. {
  1249. $consumptionPurpose = $this->getConsumptionPurpose();
  1251. if ($consumptionPurpose === null) {
  1252. return false;
  1253. }
  1255. foreach ($consumptionPurpose->getConsumptionUsage() as $cUsageObj) {
  1256. if ($cUsageObj->getConsumptionUsage() === $usage) {
  1257. return true;
  1258. }
  1259. }
  1261. return false;
  1262. }
  1264. /**
  1265. * @return ConsumptionLimit[]|Collection
  1266. */
  1267. public function getConsumptionLimits()
  1268. {
  1269. return $this->consumptionLimits;
  1270. }
  1272. /**
  1273. * @param ConsumptionLimit[]|Collection $consumptionLimits
  1274. * @return Gauge
  1275. */
  1276. public function setConsumptionLimits($consumptionLimits)
  1277. {
  1278. $this->consumptionLimits = $consumptionLimits;
  1279. return $this;
  1280. }
  1282. /**
  1283. * @param ConsumptionLimit $gaugeLimitObj
  1284. * @return ConsumptionLimit|null
  1285. */
  1286. public function getOtherLimitControl(ConsumptionLimit $gaugeLimitObj): ?ConsumptionLimit
  1287. {
  1288. $otherControls = $this->consumptionLimits->filter(
  1289. fn (ConsumptionLimit $limitItem) => $limitItem->getId() !== $gaugeLimitObj->getId()
  1290. );
  1292. return $otherControls->count() > 0 ? $otherControls->first() : null;
  1293. }
  1295. public function getLastSentNotificationAt(): ?\DateTime
  1296. {
  1297. return $this->lastSentNotificationAt;
  1298. }
  1300. public function setLastSentNotificationAt(?\DateTime $lastSentNotificationAt): Gauge
  1301. {
  1302. $this->lastSentNotificationAt = $lastSentNotificationAt;
  1303. return $this;
  1304. }
  1306. public function isRemoteAsPrimary(): bool
  1307. {
  1308. return $this->remoteAsPrimary;
  1309. }
  1311. public function setRemoteAsPrimary(bool $remoteAsPrimary): Gauge
  1312. {
  1313. $this->remoteAsPrimary = $remoteAsPrimary;
  1314. return $this;
  1315. }
  1317. public function getPrimaryMode(): int
  1318. {
  1319. if ($this->remote && $this->isRemoteAsPrimary()) {
  1320. return GaugeType::MODE_REMOTE;
  1321. }
  1323. return GaugeType::MODE_MANUAL;
  1324. }
  1326. public function getSecondaryMode(): ?int
  1327. {
  1328. if (!$this->remote) {
  1329. return null;
  1330. }
  1332. if (!$this->isRemoteAsPrimary()) {
  1333. return GaugeType::MODE_REMOTE;
  1334. }
  1336. return GaugeType::MODE_MANUAL;
  1337. }
  1339. public function isRemoteOnly(): bool
  1340. {
  1341. $fullRemote = $this->remote && $this->getPrimaryMode() === GaugeType::MODE_REMOTE;
  1343. $noManualReadingsPeriod = true;
  1345. foreach ($this->purposes as $purpose) {
  1346. if ($purpose->getReadingsPeriod() !== Period::NONE) {
  1347. $noManualReadingsPeriod = false;
  1348. }
  1349. }
  1351. return $fullRemote && $noManualReadingsPeriod;
  1352. }
  1354. public function getPurposesForManualReadings()
  1355. {
  1356. $allowedPurposes = $this->getAllowedPurposesByMeasurementTarget();
  1358. return $this->purposes->filter(function (GaugePurpose $gp) use ($allowedPurposes) {
  1359. if (!empty($allowedPurposes) && !in_array($gp->getPurpose(), $allowedPurposes, true)) {
  1360. return false;
  1361. }
  1363. return $this->isPurposeManualEnabled($gp);
  1364. });
  1365. }
  1367. public function getPurposesForRemoteReadings()
  1368. {
  1369. $allowedPurposes = $this->getAllowedPurposesByMeasurementTarget();
  1371. return $this->purposes->filter(function (GaugePurpose $gp) use ($allowedPurposes) {
  1372. if (!empty($allowedPurposes) && !in_array($gp->getPurpose(), $allowedPurposes, true)) {
  1373. return false;
  1374. }
  1376. return $this->isPurposeRemoteEnabled($gp);
  1377. });
  1378. }
  1380. /**
  1381. * Returns purposes configured for remote readings only.
  1382. * Unlike getPurposesForRemoteReadings(), this is not filtered by measurement target.
  1383. */
  1384. public function getPurposesForConfiguredRemoteReadings()
  1385. {
  1386. return $this->purposes->filter(function (GaugePurpose $gp) {
  1387. return $this->isPurposeRemoteEnabled($gp);
  1388. });
  1389. }
  1391. private function getAllowedPurposesByMeasurementTarget(): array
  1392. {
  1393. $measurementTarget = $this->getMeasurementTarget();
  1394. $map = GaugeType::getPurposesByMeasurementTarget();
  1396. if ($measurementTarget === null) {
  1397. return [];
  1398. }
  1400. return $map[$measurementTarget] ?? [];
  1401. }
  1403. private function isPurposeManualEnabled(GaugePurpose $gp): bool
  1404. {
  1405. $readingsPeriod = $gp->getReadingsPeriod();
  1406. if ($readingsPeriod === null || $readingsPeriod === Period::NONE) {
  1407. return false;
  1408. }
  1410. return $this->getPrimaryMode() === GaugeType::MODE_MANUAL
  1411. || $this->getSecondaryMode() === GaugeType::MODE_MANUAL;
  1412. }
  1414. private function isPurposeRemoteEnabled(GaugePurpose $gp): bool
  1415. {
  1416. if (!$this->isRemote()) {
  1417. return false;
  1418. }
  1420. if ($this->getPrimaryMode() !== GaugeType::MODE_REMOTE && $this->getSecondaryMode() !== GaugeType::MODE_REMOTE) {
  1421. return false;
  1422. }
  1424. if ($gp->getRemoteReadingsMinuteFrequency() !== null || $gp->getRemoteReadingsPeriod() !== null) {
  1425. return true;
  1426. }
  1428. return $gp->getRemoteUnits()->count() > 0;
  1429. }
  1431. public function getContracts(): array|Collection|null
  1432. {
  1433. return $this->contracts;
  1434. }
  1436. /**
  1437. * @param Contract[]|Collection $contracts
  1438. * @return Gauge
  1439. */
  1440. public function setContracts($contracts): Gauge
  1441. {
  1442. $this->contracts = $contracts;
  1443. return $this;
  1444. }
  1446. public function addContract(Contract $contract): Gauge
  1447. {
  1448. if ($this->contracts === null) {
  1449. $this->contracts = new ArrayCollection();
  1450. }
  1451. if (!$this->contracts->contains($contract)) {
  1452. $this->contracts->add($contract);
  1453. }
  1455. return $this;
  1456. }
  1458. public function removeContract(Contract $contract): Gauge
  1459. {
  1460. if ($this->contracts === null) {
  1461. $this->contracts = new ArrayCollection();
  1462. }
  1464. if ($this->contracts->contains($contract)) {
  1465. $this->contracts->removeElement($contract);
  1466. $contract->removeGauge($this);
  1467. }
  1469. return $this;
  1470. }
  1471. }