src/Entity/Point.php line 247

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use ApiPlatform\Core\Annotation\ApiFilter;
  6. use ApiPlatform\Core\Annotation\ApiSubresource;
  7. use Doctrine\ORM\PersistentCollection;
  8. use JsonSerializable;
  10. use ApiPlatform\Core\Annotation\ApiResource;
  11. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
  12. use ApiPlatform\Core\Serializer\Filter\PropertyFilter;
  13. use Doctrine\Common\Collections\ArrayCollection;
  14. use Doctrine\Common\Collections\Collection;
  15. use Doctrine\ORM\Mapping as ORM;
  16. use Symfony\Component\Serializer\Annotation\Groups;
  18. /**
  19.  * @ApiResource(
  20.  *     collectionOperations={"get", "post"},
  21.  *     itemOperations={
  22.  *          "get"={
  23.  *              "normalization_context"={"groups"={"point:read", "point:item:get", "point_controller:item:get"}},
  24.  *          },
  25.  *          "put",
  26.  *     },
  27.  *     shortName="points",
  28.  *     normalizationContext={  "groups"={"point:read"},  "swagger_definition_name"="Read"},
  29.  *     denormalizationContext={"groups"={"point:write"}, "swagger_definition_name"="Write"},
  30.  *     attributes={
  31.  *          "pagination_items_per_page"=100,
  32.  *          "formats"={"jsonld", "json", "html", "csv"}
  33.  *     }
  34.  * )
  35.  * @ApiFilter(PropertyFilter::class)
  36.  * @ApiFilter(SearchFilter::class, properties={"networkInstallation.id": "exact", "pointController.id": "exact"})
  37.  * Class Point
  38.  * @package App\Entity
  39.  *
  40.  * @ORM\Entity(repositoryClass="App\Repository\PointRepository")
  41.  * @ORM\Table(name="points")
  42.  */
  43. class Point implements JsonSerializable
  44. {
  45.     /**
  46.      * @ORM\Id()
  47.      * @ORM\GeneratedValue()
  48.      * @ORM\Column(type="integer")
  49.      * @Groups({"point:read", "point_controller:item:get", "screen_point:read", "screen_point:item:get", "shape_point:read", "shape_point:item:get"})
  50.      */
  51.     private $id;
  53.     /**
  54.      * @ORM\Column(type="string", length=128, nullable=true)
  55.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "screen_point:item:get", "shape_point:read", "shape_point:item:get"})
  56.      */
  57.     private $name;
  59.     /**
  60.      * @ORM\Column(type="string", length=128, nullable=true)
  61.      */
  62.     private $nameLower;
  64.     /**
  65.      * @ORM\Column(type="string", length=232, nullable=true)
  66.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "screen_point:item:get", "shape_point:read", "shape_point:item:get"})
  67.      */
  68.     private $description;
  70.     /**
  71.      * @ORM\Column(type="string", length=32, nullable=true)
  72.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "shape_point:read", "shape_point:item:get"})
  73.      */
  74.     private $address;
  76.     /**
  77.      * @ORM\Column(type="boolean", nullable=true)
  78.      * @Groups({"point:read", "point:write", "point_controller:item:get"})
  79.      */
  80.     private $onOverview;
  82.     /**
  83.      * @ORM\Column(type="boolean", nullable=true)
  84.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "shape_point:read", "shape_point:item:get"})
  85.      */
  86.     private $isVisible;
  88.     /**
  89.      * @ORM\Column(type="string", length=128, nullable=true)
  90.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "shape_point:read", "shape_point:item:get"})
  91.      */
  92.     private $visibility;
  95.     /**
  96.      * @ORM\Column(type="boolean", nullable=true)
  97.      */
  98.     private $isGlobal;
  100.     /**
  101.      * @ORM\Column(type="boolean", nullable=true)
  102.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "shape_point:read", "shape_point:item:get"})
  103.      */
  104.     private $isAssigned;
  106.     /**
  107.      * @ORM\Column(type="string", length=128, nullable=true)
  108.      * @Groups({"point:read", "point:write", "point_controller:item:get", "screen_point:read", "shape_point:read", "shape_point:item:get"})
  109.      */
  110.     private $pointGroup;
  112.     /**
  113.      * @ORM\Column(type="string", length=16, nullable=true)
  114.      * @Groups({"point:read", "point:write", "point_controller:item:get"})
  115.      */
  116.     private $sourceType;
  118.     /**
  119.      * @ORM\Column(type="datetime", nullable=false)
  120.      * @Groups({"point:read", "point:write", "point_controller:item:get"})
  121.      */
  122.     private $dateAdded;
  124.     /**
  125.      * @ORM\Column(type="datetime", nullable=false)
  126.      * @Groups({"point:read", "point:write", "point_controller:item:get"})
  127.      */
  128.     private $dateModified;
  131.     /* ~~~~~~~~~~~~~~~~ OneToOne ~~~~~~~~~~~~~~~~ */
  133.     /**
  134.      * @ORM\OneToOne(targetEntity="App\Entity\PanelPoint", mappedBy="point", cascade={"persist"}, fetch="EXTRA_LAZY")
  135.      * @Groups({"point:read", "point:write", "point_controller:item:get"})
  136.      */
  137.     private $panelPoint;
  140.     /* ~~~~~~~~~~~~~~~~ OneToMany ~~~~~~~~~~~~~~~~ */
  142.     /**
  143.      * @ORM\OneToMany(targetEntity="App\Entity\ScreenPoint", mappedBy="point", cascade={"persist"}, fetch="EXTRA_LAZY")
  144.      * @Groups({"point:read", "point:write", "point:item:get", "point_controller:item:get"})
  145.      * @ApiSubresource()
  146.      */
  147.     private $screenPoints;
  149.     /**
  150.      * @ORM\OneToMany(targetEntity="App\Entity\ShapePoint", mappedBy="point", cascade={"persist"}, fetch="EXTRA_LAZY")
  151.      * @Groups({"point:read", "point:write", "point:item:get", "point_controller:item:get"})
  152.      * @ApiSubresource()
  153.      */
  154.     private $shapePoints;
  157.     /* ~~~~~~~~~~~~~~~~ ManyToOne ~~~~~~~~~~~~~~~~ */
  159.     /**
  160.      * @ORM\ManyToOne(targetEntity="App\Entity\PointType", inversedBy="points", cascade={"persist"}, fetch="EXTRA_LAZY")
  161.      * @Groups({"point:read", "point:write", "point:item:get", "point_controller:item:get"})
  162.      */
  163.     private $pointType;
  165.     /**
  166.      * @ORM\ManyToOne(targetEntity="App\Entity\PointController", inversedBy="points", cascade={"persist"}, fetch="EXTRA_LAZY")
  167.      * @Groups({"point:read", "point:write", "point:item:get"})
  168.      */
  169.     private $pointController;
  171.     /**
  172.      * @ORM\ManyToOne(targetEntity="App\Entity\Facility", inversedBy="points", cascade={"persist"}, fetch="EXTRA_LAZY")
  173.      */
  174.     private $facility;
  176.     /**
  177.      * @ORM\ManyToOne(targetEntity="App\Entity\NetworkInstallation", inversedBy="points", cascade={"persist"}, fetch="EXTRA_LAZY")
  178.      */
  179.     private $networkInstallation;
  182.     /* ~~~~~~~~~~~~~~~~ ManyToMany ~~~~~~~~~~~~~~~~ */
  184.     /**
  185.      * @ORM\ManyToMany(targetEntity=EquipmentGroup::class, mappedBy="points")
  186.      * @Groups({"point:read", "point:write", "point:item:get"})
  187.      */
  188.     private $equipmentGroups;
  193.     public function __construct()
  194.                    {
  195.                        $this->dateAdded = new \DateTime();
  196.                        $this->setDateModified();
  197.                        $this->screenPoints = new ArrayCollection();
  198.                        $this->shapePoints = new ArrayCollection();
  199.                        $this->equipmentGroups = new ArrayCollection();
  200.                    }
  202.     public function __toString()
  203.                    {
  204.                        return (string) $this->getName();
  205.                    }
  207.     /**
  208.      * @param string $property
  209.      * @return mixed
  210.      */
  211.     public function __get(string $property)
  212.     {
  213.         // attempt to use the method
  214.         $methodName = 'get' . ucfirst( $property );
  215.         if( method_exists( $this, $methodName ) ){
  216.             return $this->{$methodName}( $property );
  217.         }
  219.         // attempt to use the method
  220.         if (property_exists($this, $property)) {
  221.             return $this->$property;
  222.         }
  223.         return null;
  224.     }
  226.     /**
  227.      * @param string $property
  228.      * @param mixed $value
  229.      * @return bool
  230.      */
  231.     public function __set(string $property, $value) {
  232.         // attempt to use the method
  233.         $methodName = 'set' . ucfirst( $property );
  234.         if( method_exists( $this, $methodName ) ){
  235.             $this->{$methodName}( $property, $value );
  236.             return true;
  237.         }
  239.         // attempt to use the method
  240.         if (property_exists($this, $property)) {
  241.             $this->$property = $value;
  242.             return true;
  243.         }
  244.         return false;
  245.     }
  247.     public function jsonSerialize()
  248.     {
  249.         return array(
  250.             'id'           => $this->id,
  251.             'name'         => $this->name,
  252.             'description'  => $this->description,
  253.             'address'      => $this->address,
  254.             'onOverview'   => $this->onOverview,
  255.             'isVisible'    => $this->isVisible,
  256.             'visibility'   => $this->visibility,
  257.             'isGlobal'     => $this->isGlobal,
  258.             'isAssigned'   => $this->isAssigned,
  259.             'pointGroup'   => $this->pointGroup,
  260.             'sourceType'   => $this->sourceType,
  261.             'dateAdded'    => $this->dateAdded,
  262.             'dateModified' => $this->dateModified,
  263.             'screenPoints' => $this->getScreenPoints()->toArray(),
  264.             'shapePoints'  => $this->getShapePoints()->toArray(),
  265.         );
  266.     }
  267.     
  268.     public function serializeForTable( array $pointsWithRules = array() )
  269.     {
  270.         return array(
  271.             "DT_RowId" => "row_" . $this->getId(),
  272.             'point_id' => $this->getId(),
  273.             'dragBars' => "<i class='fas fa-bars grey'></i>",
  274.             'controllerName' => $this->getPointController()->getName(),
  275.             'pointDetail' => "<a data-toggle='modal' data-target='#pointDetailModal' data-pointid='" . $this->getId() . "' data-pointname='" . $this->getName() . "' href='#'>" . $this->getName() . "</a>",
  276.             'pointName' => $this->getName(),
  277.             'pointDescription' => $this->getDescription(),
  278.             'pointType' => (!is_null( $this->getPointType())) ? $this->getPointType()->getName() : 'Undefined',
  279.             'pointVisibility' => ($this->getIsVisible()) ? "Visible" : "Hidden",
  280.             'pointGroup' => $this->getPointGroup(),
  281.             'pointAssigned' => ($this->getIsAssigned()) ? "A" : "U",
  282.             'pointAssignedFull' => ($this->getIsAssigned()) ? "Assigned" : "Unassigned",
  283.             'manualConfRulesApplied' => ( array_key_exists( $this->getId(), $pointsWithRules ) ) ? "<span class='fa fas fa-exclamation-circle text-warning' tabindex='0' data-toggle='tooltip' title='Manual changes have been applied.'></span>" : '',
  284.         );
  285.     }
  287.     /**
  288.      * get id
  289.      *
  290.      * @return integer
  291.      */
  292.     public function getId()
  293.     {
  294.         return $this->id;
  295.     }
  297.     /**
  298.      * get name
  299.      *
  300.      * @return string
  301.      */
  302.     public function getName()
  303.     {
  304.         return $this->name;
  305.     }
  307.     /**
  308.      * set name
  309.      *
  310.      * @param string $name
  311.      *
  312.      * @return Point
  313.      */
  314.     public function setName($name)
  315.     {
  316.         $this->name = $name;
  317.         $this->nameLower = strtolower( $name );
  319.         return $this;
  320.     }
  322.     /**
  323.      * get nameLower
  324.      *
  325.      * @return string
  326.      */
  327.     public function getNameLower()
  328.     {
  329.         return $this->nameLower;
  330.     }
  332.     /**
  333.      * set nameLower
  334.      *
  335.      * @param string $nameLower
  336.      *
  337.      * @return Point
  338.      */
  339.     public function setNameLower($nameLower)
  340.     {
  341.         $this->nameLower = strtolower($nameLower);
  343.         return $this;
  344.     }
  345.     
  346.     /**
  347.      * get description
  348.      *
  349.      * @return string
  350.      */
  351.     public function getDescription()
  352.     {
  353.         return $this->description;
  354.     }
  356.     /**
  357.      * set description
  358.      *
  359.      * @param string $description
  360.      *
  361.      * @return Point
  362.      */
  363.     public function setDescription($description)
  364.     {
  365.         $this->description = $description;
  367.         return $this;
  368.     }
  370.     /**
  371.      * get address
  372.      *
  373.      * @return string
  374.      */
  375.     public function getAddress()
  376.     {
  377.         return $this->address;
  378.     }
  380.     /**
  381.      * set address
  382.      *
  383.      * @param string $address
  384.      *
  385.      * @return Point
  386.      */
  387.     public function setAddress($address)
  388.     {
  389.         $this->address = $address;
  391.         return $this;
  392.     }
  394.     /**
  395.      * get onOverview
  396.      *
  397.      * @return boolean
  398.      */
  399.     public function getOnOverview()
  400.     {
  401.         return $this->onOverview;
  402.     }
  404.     /**
  405.      * set onOverview
  406.      *
  407.      * @param boolean $onOverview
  408.      *
  409.      * @return Point
  410.      */
  411.     public function setOnOverview($onOverview)
  412.     {
  413.         $this->onOverview = $onOverview;
  415.         return $this;
  416.     }
  418.     /**
  419.      * get isVisible
  420.      *
  421.      * @return boolean
  422.      */
  423.     public function getIsVisible()
  424.     {
  425.         return $this->isVisible;
  426.     }
  428.     /**
  429.      * set isVisible
  430.      *
  431.      * @param boolean $isVisible
  432.      *
  433.      * @return Point
  434.      */
  435.     public function setIsVisible($isVisible)
  436.     {
  437.         $this->isVisible = $isVisible;
  439.         return $this;
  440.     }
  442.     /**
  443.      * get isGlobal
  444.      *
  445.      * @return boolean
  446.      */
  447.     public function getIsGlobal()
  448.     {
  449.         return $this->isGlobal;
  450.     }
  452.     /**
  453.      * set isGlobal
  454.      *
  455.      * @param boolean $isGlobal
  456.      *
  457.      * @return Point
  458.      */
  459.     public function setIsGlobal($isGlobal)
  460.     {
  461.         $this->isGlobal = $isGlobal;
  463.         return $this;
  464.     }
  466.     /**
  467.      * get isAssigned
  468.      *
  469.      * @return boolean
  470.      */
  471.     public function getIsAssigned()
  472.     {
  473.         return ($this->isAssigned === true);
  474.     }
  476.     /**
  477.      * set isAssigned
  478.      *
  479.      * @param boolean $isAssigned
  480.      *
  481.      * @return Point
  482.      */
  483.     public function setIsAssigned($isAssigned)
  484.     {
  485.         if( !is_null( $isAssigned ) ){
  486.             $this->isAssigned = $isAssigned;
  487.         } else {
  488.             if( count( $this->getScreenPoints() ) > 0 ){
  489.                 $this->isAssigned = true;
  490.             } else {
  491.                 $this->isAssigned = false;
  492.             }
  493.         }
  495.         return $this;
  496.     }
  498.     /**
  499.      * get sourceType
  500.      *
  501.      * @return string
  502.      */
  503.     public function getSourceType()
  504.                    {
  505.                        return $this->sourceType;
  506.                    }
  508.     /**
  509.      * set sourceType
  510.      *
  511.      * @param string $sourceType
  512.      *
  513.      * @return Point
  514.      */
  515.     public function setSourceType($sourceType)
  516.                    {
  517.                        $this->sourceType = $sourceType;
  518.                
  519.                        return $this;
  520.                    }
  522.     /**
  523.      * get visibility
  524.      *
  525.      * @return string
  526.      */
  527.     public function getVisibility()
  528.     {
  529.         return $this->visibility;
  530.     }
  532.     /**
  533.      * set visibility
  534.      *
  535.      * @param string $visibility
  536.      *
  537.      * @return Point
  538.      */
  539.     public function setVisibility($visibility)
  540.     {
  541.         $this->visibility = $visibility;
  543.         return $this;
  544.     }
  546.     /**
  547.      * get pointGroup
  548.      *
  549.      * @return string
  550.      */
  551.     public function getPointGroup()
  552.     {
  553.         return $this->pointGroup;
  554.     }
  556.     /**
  557.      * set pointGroup
  558.      *
  559.      * @param string $pointGroup
  560.      *
  561.      * @return Point
  562.      */
  563.     public function setPointGroup($pointGroup)
  564.     {
  565.         $this->pointGroup = $pointGroup;
  567.         return $this;
  568.     }
  570.     /**
  571.      * get getDateAdded
  572.      *
  573.      * @return \DateTime
  574.      */
  575.     public function getDateAdded()
  576.     {
  577.         return $this->dateAdded;
  578.     }
  580.     /**
  581.      * get date modified
  582.      *
  583.      * @return \DateTime
  584.      */
  585.     public function getDateModified()
  586.                    {
  587.                        return $this->dateModified;
  588.                    }
  590.     /**
  591.      * set date modified
  592.      *
  593.      * @return \DateTime
  594.      */
  595.     public function setDateModified()
  596.                     {
  597.                         $this->dateModified = new \DateTime("now");
  598.                     }
  601.     /* ~~~~~~~~~~~~~~~~ OneToOne ~~~~~~~~~~~~~~~~ */
  603.     /**
  604.      * @return PanelPoint
  605.      */
  606.     public function getPanelPoint(): ?PanelPoint
  607.     {
  608.         return $this->panelPoint;
  609.     }
  611.     /**
  612.      * @param PanelPoint $panelPoint
  613.      * @return Point
  614.      */
  615.     public function setPanelPoint(PanelPoint $panelPoint): Point
  616.     {
  617.         $this->panelPoint = $panelPoint;
  618.         if( $panelPoint->getPoint() !== $this ){
  619.             $panelPoint->setPoint($this);
  620.         }
  621.         return $this;
  622.     }
  625.     /* ~~~~~~~~~~~~~~~~ ManyToOne ~~~~~~~~~~~~~~~~ */
  627.     /**
  628.      * get pointType
  629.      *
  630.      * @return PointType
  631.      */
  632.     public function getPointType()
  633.     {
  634.         return $this->pointType;
  635.     }
  637.     /**
  638.      * set pointType
  639.      *
  640.      * @param PointType $pointType
  641.      *
  642.      * @return Point
  643.      */
  644.     public function setPointType(PointType $pointType)
  645.     {
  646.         $this->pointType = $pointType;
  648.         return $this;
  649.     }
  651.     /**
  652.      * get pointController
  653.      *
  654.      * @return PointController
  655.      */
  656.     public function getPointController()
  657.     {
  658.         return $this->pointController;
  659.     }
  661.     /**
  662.      * set pointController
  663.      *
  664.      * @param PointController $pointController
  665.      *
  666.      * @return Point
  667.      */
  668.     public function setPointController(PointController $pointController)
  669.     {
  670.         $this->pointController = $pointController;
  671.         $pointController->addPoint( $this );
  673.         return $this;
  674.     }
  676.     /**
  677.      * get facility
  678.      *
  679.      * @return Facility
  680.      */
  681.     public function getFacility()
  682.     {
  683.         return $this->facility;
  684.     }
  686.     /**
  687.      * set facility
  688.      *
  689.      * @param Facility $facility
  690.      *
  691.      * @return Point
  692.      */
  693.     public function setFacility(Facility $facility)
  694.     {
  695.         if( !is_null( $facility ) ){
  696.             // update the inverse side
  697.             $facility->addPoint( $this );
  698.         } else {
  699.             $facility->addPoint( null );
  700.         }
  702.         $this->facility = $facility;
  704.         return $this;
  705.     }
  707.     /**
  708.      * get networkInstallation
  709.      *
  710.      * @return NetworkInstallation
  711.      */
  712.     public function getNetworkInstallation()
  713.     {
  714.         return $this->networkInstallation;
  715.     }
  717.     /**
  718.      * set networkInstallation
  719.      *
  720.      * @param NetworkInstallation $networkInstallation
  721.      *
  722.      * @return Point
  723.      */
  724.     public function setNetworkInstallation(NetworkInstallation $networkInstallation)
  725.     {
  726.         $this->networkInstallation = $networkInstallation;
  727.         $networkInstallation->addPoint( $this );
  729.         return $this;
  730.     }
  733.     /* ~~~~~~~~~~~~~~~~ ManyToMany ~~~~~~~~~~~~~~~~ */
  736.     /**
  737.      * Add screen point
  738.      *
  739.      * @param ScreenPoint $screenPoint
  740.      *
  741.      * @return Point
  742.      */
  743.     public function addScreenPoint(ScreenPoint $screenPoint)
  744.     {
  745.         if (!$this->screenPoints->contains($screenPoint)) {
  746.             $this->screenPoints[] = $screenPoint;
  747.             $screenPoint->setPoint($this);
  748.         }
  750.         if( $this->screenPoints->count() > 0 ) $this->setIsAssigned(true);
  752.         return $this;
  753.     }
  755.     /**
  756.      * Remove screen point
  757.      *
  758.      * @param ScreenPoint $screenPoint
  759.      *
  760.      * @return Point
  761.      */
  762.     public function removeScreenPoint(ScreenPoint $screenPoint)
  763.     {
  764.         if ($this->screenPoints->contains($screenPoint)) {
  765.             $this->screenPoints->removeElement($screenPoint);
  766.             $screenPoint->removePoint();
  767.         }
  769.         if( $this->screenPoints->count() === 0 ) $this->setIsAssigned(false);
  771.         return $this;
  772.     }
  774.     public function getScreenPoints()
  775.     {
  776.         return $this->screenPoints;
  777.     }
  779.     // todo: add addScreenPoints, removeScreenPoints
  781.     /**
  782.      * Add shape point
  783.      *
  784.      * @param ShapePoint $shapePoint
  785.      *
  786.      * @return Point
  787.      */
  788.     public function addShapePoint(ShapePoint $shapePoint)
  789.     {
  790.         if (!$this->shapePoints->contains($shapePoint)) {
  791.             $this->shapePoints[] = $shapePoint;
  792.             $shapePoint->setPoint($this);
  793.         }
  795.         return $this;
  796.     }
  798.     /**
  799.      * Remove shape point
  800.      *
  801.      * @param ShapePoint $shapePoint
  802.      *
  803.      * @return Point
  804.      */
  805.     public function removeShapePoint(ShapePoint $shapePoint)
  806.     {
  807.         if ($this->shapePoints->contains($shapePoint)) {
  808.             $this->shapePoints->removeElement($shapePoint);
  809.             $shapePoint->removePoint();
  810.         }
  812.         return $this;
  813.     }
  815.     public function getShapePoints()
  816.     {
  817.         return $this->shapePoints;
  818.     }
  820.     // todo: add addShapePoints, removeShapePoints
  822.     /**
  823.      * @return Collection|EquipmentGroup[]
  824.      */
  825.     public function getEquipmentGroups(): Collection
  826.     {
  827.         return $this->equipmentGroups;
  828.     }
  830.     public function addEquipmentGroup(EquipmentGroup $equipmentGroup): self
  831.     {
  832.         if (!$this->equipmentGroups->contains($equipmentGroup)) {
  833.             $this->equipmentGroups[] = $equipmentGroup;
  834.             $equipmentGroup->addPoint($this);
  835.         }
  837.         return $this;
  838.     }
  840.     public function removeEquipmentGroup(EquipmentGroup $equipmentGroup): self
  841.     {
  842.         if ($this->equipmentGroups->removeElement($equipmentGroup)) {
  843.             $equipmentGroup->removePoint($this);
  844.         }
  846.         return $this;
  847.     }
  849. }