src/Entity/SspEndpoint.php line 25

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Model\GeoEdge\ScanFrequency;
  6. use DateTime;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Gedmo\Mapping\Annotation as Gedmo;
  9. use InvalidArgumentException;
  11. /**
  12.  * SSP Endpoint entity.
  13.  *
  14.  * @ORM\Table(
  15.  *     name="ssp_endpoints",
  16.  *     uniqueConstraints={
  17.  *          @ORM\UniqueConstraint(name="uk_ssp_endpoint_abbr", columns={"abbr"}),
  18.  *          @ORM\UniqueConstraint(name="uk_ssp_endpoint_name", columns={"name"}),
  19.  *          @ORM\UniqueConstraint(name="uk_ssp_endpoint_endpoint", columns={"endpoint"}),
  20.  *          @ORM\UniqueConstraint(name="uk_ssp_endpoint_ad_id", columns={"ad_id"})
  21.  *     }
  22.  * )
  23.  * @ORM\Entity(repositoryClass="App\Repository\SspEndpointRepository")
  24.  */
  25. class SspEndpoint
  26. {
  27.     /**
  28.      * @var int
  29.      *
  30.      * @ORM\Id()
  31.      * @ORM\GeneratedValue(strategy="AUTO")
  32.      * @ORM\Column(name="id", type="integer", nullable=false)
  33.      */
  34.     private $id;
  36.     /**
  37.      * @var string
  38.      *
  39.      * @ORM\Column(name="abbr", type="string", length=8, nullable=false)
  40.      */
  41.     private $abbr;
  43.     /**
  44.      * @var string
  45.      *
  46.      * @ORM\Column(name="name", type="string", length=64, nullable=false)
  47.      */
  48.     private $name;
  50.     /**
  51.      * @var string
  52.      *
  53.      * @ORM\Column(name="endpoint", type="string", length=255, nullable=false)
  54.      */
  55.     private $endpoint;
  57.     /**
  58.      * @var string
  59.      *
  60.      * @ORM\Column(name="protocol", type="string", length=16, nullable=false)
  61.      */
  62.     private $protocol;
  64.     /**
  65.      * @var int
  66.      *
  67.      * @ORM\Column(name="ad_id", type="integer", nullable=false)
  68.      */
  69.     private $adId;
  71.     /**
  72.      * @var array
  73.      *
  74.      * @ORM\Column(name="countries", type="simple_array", nullable=true)
  75.      */
  76.     private $countries = [];
  78.     /**
  79.      * @var array
  80.      *
  81.      * @ORM\Column(name="device_types", type="simple_array", nullable=true)
  82.      */
  83.     private $deviceTypes = [];
  85.     /**
  86.      * How many times a target should be scanned per day. (GeoEdge times_per_day)
  87.      *
  88.      * @var int
  89.      *
  90.      * @ORM\Column(name="scan_frequency", type="integer", nullable=false, options={"default": 48})
  91.      */
  92.     private $scanFrequency = ScanFrequency::TIMES_PER_DAY_SSP;
  94.     /**
  95.      * @var bool
  96.      *
  97.      * @ORM\Column(name="enabled", type="boolean", options={"default": 1}, nullable=false)
  98.      */
  99.     private $enabled = true;
  101.     /**
  102.      * @var DateTime
  103.      *
  104.      * @ORM\Column(name="created", type="datetime", nullable=false)
  105.      * @Gedmo\Timestampable(on="create")
  106.      */
  107.     private $created;
  109.     /**
  110.      * @var DateTime
  111.      *
  112.      * @ORM\Column(name="updated", type="datetime", nullable=false)
  113.      * @Gedmo\Timestampable(on="update")
  114.      */
  115.     private $updated;
  117.     /**
  118.      * Gets the id.
  119.      *
  120.      * @return int
  121.      */
  122.     public function getId(): int
  123.     {
  124.         return $this->id;
  125.     }
  127.     /**
  128.      * Sets the id.
  129.      *
  130.      * @param int $id
  131.      * @return $this
  132.      */
  133.     public function setId(int $id): self
  134.     {
  135.         $this->id = $id;
  137.         return $this;
  138.     }
  140.     /**
  141.      * Gets the abbreviated name.
  142.      *
  143.      * @return string
  144.      */
  145.     public function getAbbr(): string
  146.     {
  147.         return $this->abbr;
  148.     }
  150.     /**
  151.      * Sets the abbreviated name.
  152.      *
  153.      * @param string $abbr
  154.      * @return $this
  155.      */
  156.     public function setAbbr(string $abbr): self
  157.     {
  158.         $this->abbr = strtoupper($abbr);
  160.         return $this;
  161.     }
  163.     /**
  164.      * Gets the name.
  165.      *
  166.      * @return string
  167.      */
  168.     public function getName(): string
  169.     {
  170.         return $this->name;
  171.     }
  173.     /**
  174.      * Sets the name.
  175.      *
  176.      * @param string $name
  177.      * @return $this
  178.      */
  179.     public function setName(string $name): self
  180.     {
  181.         $this->name = $name;
  183.         return $this;
  184.     }
  186.     /**
  187.      * Gets the endpoint.
  188.      *
  189.      * @return string
  190.      */
  191.     public function getEndpoint(): string
  192.     {
  193.         return $this->endpoint;
  194.     }
  196.     /**
  197.      * Sets the endpoint.
  198.      *
  199.      * @param string $endpoint
  200.      * @return $this
  201.      */
  202.     public function setEndpoint(string $endpoint): self
  203.     {
  204.         $this->endpoint = $endpoint;
  206.         return $this;
  207.     }
  209.     /**
  210.      * Gets the protocol.
  211.      *
  212.      * @return string
  213.      */
  214.     public function getProtocol(): string
  215.     {
  216.         return $this->protocol;
  217.     }
  219.     /**
  220.      * Sets the protocol.
  221.      *
  222.      * @param string $protocol
  223.      * @return $this
  224.      */
  225.     public function setProtocol(string $protocol): self
  226.     {
  227.         $this->protocol = $protocol;
  229.         return $this;
  230.     }
  232.     /**
  233.      * Gets the ad id.
  234.      *
  235.      * @return int
  236.      */
  237.     public function getAdId(): int
  238.     {
  239.         return $this->adId;
  240.     }
  242.     /**
  243.      * Sets the ad id.
  244.      *
  245.      * @param int $adId
  246.      * @return $this
  247.      */
  248.     public function setAdId(int $adId): self
  249.     {
  250.         $this->adId = $adId;
  252.         return $this;
  253.     }
  255.     /**
  256.      * Get countries.
  257.      *
  258.      * @return array
  259.      */
  260.     public function getCountries(): array
  261.     {
  262.         return $this->countries;
  263.     }
  265.     /**
  266.      * Set countries.
  267.      *
  268.      * @param array $countries
  269.      * @return $this
  270.      */
  271.     public function setCountries(array $countries): self
  272.     {
  273.         $this->countries = $countries;
  275.         return $this;
  276.     }
  278.     /**
  279.      * Get valid device types.
  280.      *
  281.      * @return array
  282.      */
  283.     public function getDeviceTypes(): array
  284.     {
  285.         return $this->deviceTypes;
  286.     }
  288.     /**
  289.      * Set valid device types.
  290.      *
  291.      * @param array $deviceTypes
  292.      * @return $this
  293.      */
  294.     public function setDeviceTypes(array $deviceTypes): self
  295.     {
  296.         $this->deviceTypes = $deviceTypes;
  298.         return $this;
  299.     }
  301.     /**
  302.      * Gets the scan frequency.
  303.      *
  304.      * @return int
  305.      */
  306.     public function getScanFrequency(): int
  307.     {
  308.         return $this->scanFrequency;
  309.     }
  311.     /**
  312.      * Sets the scan frequency.
  313.      *
  314.      * @param int $scanFrequency
  315.      * @return $this
  316.      */
  317.     public function setScanFrequency(int $scanFrequency): self
  318.     {
  319.         if (!ScanFrequency::isValid($scanFrequency)) {
  320.             throw new InvalidArgumentException("The scan frequency {$scanFrequency} is not valid!");
  321.         }
  323.         $this->scanFrequency = $scanFrequency;
  325.         return $this;
  326.     }
  328.     /**
  329.      * If project is enabled.
  330.      *
  331.      * @return bool
  332.      */
  333.     public function isEnabled(): bool
  334.     {
  335.         return $this->enabled;
  336.     }
  338.     /**
  339.      * Sets if project is enabled.
  340.      *
  341.      * @param bool $enabled
  342.      * @return $this
  343.      */
  344.     public function setEnabled(bool $enabled): self
  345.     {
  346.         $this->enabled = $enabled;
  348.         return $this;
  349.     }
  351.     /**
  352.      * Gets the created date.
  353.      *
  354.      * @return DateTime
  355.      */
  356.     public function getCreated(): DateTime
  357.     {
  358.         return ($this->created ?? new DateTime());
  359.     }
  361.     /**
  362.      * Sets the created date.
  363.      *
  364.      * @param DateTime $created
  365.      * @return $this
  366.      */
  367.     public function setCreated(DateTime $created): self
  368.     {
  369.         $this->created = $created;
  371.         return $this;
  372.     }
  374.     /**
  375.      * Gets the updated value.
  376.      *
  377.      * @return DateTime
  378.      */
  379.     public function getUpdated(): DateTime
  380.     {
  381.         return ($this->updated ?? new DateTime());
  382.     }
  384.     /**
  385.      * Sets the updated value.
  386.      *
  387.      * @param DateTime $updated
  388.      * @return $this
  389.      */
  390.     public function setUpdated(DateTime $updated): self
  391.     {
  392.         $this->updated = $updated;
  394.         return $this;
  395.     }
  396. }