Created Core module

module/Core/src/Entity/RestToken.php

@@ -0,0 +1,103 @@
+<?php
+namespace Shlinkio\Shlink\Core\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Shlinkio\Shlink\Common\Entity\AbstractEntity;
+use Shlinkio\Shlink\Common\Util\StringUtilsTrait;
+
+/**
+ * Class RestToken
+ * @author
+ * @link
+ *
+ * @ORM\Entity()
+ * @ORM\Table(name="rest_tokens")
+ */
+class RestToken extends AbstractEntity
+{
+    use StringUtilsTrait;
+
+    /**
+     * The default interval is 20 minutes
+     */
+    const DEFAULT_INTERVAL = 'PT20M';
+
+    /**
+     * @var \DateTime
+     * @ORM\Column(type="datetime", name="expiration_date", nullable=false)
+     */
+    protected $expirationDate;
+    /**
+     * @var string
+     * @ORM\Column(nullable=false)
+     */
+    protected $token;
+
+    public function __construct()
+    {
+        $this->updateExpiration();
+        $this->setRandomTokenKey();
+    }
+
+    /**
+     * @return \DateTime
+     */
+    public function getExpirationDate()
+    {
+        return $this->expirationDate;
+    }
+
+    /**
+     * @param \DateTime $expirationDate
+     * @return $this
+     */
+    public function setExpirationDate($expirationDate)
+    {
+        $this->expirationDate = $expirationDate;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getToken()
+    {
+        return $this->token;
+    }
+
+    /**
+     * @param string $token
+     * @return $this
+     */
+    public function setToken($token)
+    {
+        $this->token = $token;
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isExpired()
+    {
+        return new \DateTime() > $this->expirationDate;
+    }
+
+    /**
+     * Updates the expiration of the token, setting it to the default interval in the future
+     * @return $this
+     */
+    public function updateExpiration()
+    {
+        return $this->setExpirationDate((new \DateTime())->add(new \DateInterval(self::DEFAULT_INTERVAL)));
+    }
+
+    /**
+     * Sets a random unique token key for this RestToken
+     * @return RestToken
+     */
+    public function setRandomTokenKey()
+    {
+        return $this->setToken($this->generateV4Uuid());
+    }
+}

module/Core/src/Entity/ShortUrl.php

@@ -0,0 +1,138 @@
+<?php
+namespace Shlinkio\Shlink\Core\Entity;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping as ORM;
+use Shlinkio\Shlink\Common\Entity\AbstractEntity;
+
+/**
+ * Class ShortUrl
+ * @author
+ * @link
+ *
+ * @ORM\Entity(repositoryClass="Shlinkio\Shlink\Core\Repository\ShortUrlRepository")
+ * @ORM\Table(name="short_urls")
+ */
+class ShortUrl extends AbstractEntity implements \JsonSerializable
+{
+    /**
+     * @var string
+     * @ORM\Column(name="original_url", type="string", nullable=false, length=1024)
+     */
+    protected $originalUrl;
+    /**
+     * @var string
+     * @ORM\Column(name="short_code", type="string", nullable=false, length=10, unique=true)
+     */
+    protected $shortCode;
+    /**
+     * @var \DateTime
+     * @ORM\Column(name="date_created", type="datetime")
+     */
+    protected $dateCreated;
+    /**
+     * @var Collection|Visit[]
+     * @ORM\OneToMany(targetEntity=Visit::class, mappedBy="shortUrl", fetch="EXTRA_LAZY")
+     */
+    protected $visits;
+
+    /**
+     * ShortUrl constructor.
+     */
+    public function __construct()
+    {
+        $this->setDateCreated(new \DateTime());
+        $this->setVisits(new ArrayCollection());
+        $this->setShortCode('');
+    }
+
+    /**
+     * @return string
+     */
+    public function getOriginalUrl()
+    {
+        return $this->originalUrl;
+    }
+
+    /**
+     * @param string $originalUrl
+     * @return $this
+     */
+    public function setOriginalUrl($originalUrl)
+    {
+        $this->originalUrl = (string) $originalUrl;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getShortCode()
+    {
+        return $this->shortCode;
+    }
+
+    /**
+     * @param string $shortCode
+     * @return $this
+     */
+    public function setShortCode($shortCode)
+    {
+        $this->shortCode = $shortCode;
+        return $this;
+    }
+
+    /**
+     * @return \DateTime
+     */
+    public function getDateCreated()
+    {
+        return $this->dateCreated;
+    }
+
+    /**
+     * @param \DateTime $dateCreated
+     * @return $this
+     */
+    public function setDateCreated($dateCreated)
+    {
+        $this->dateCreated = $dateCreated;
+        return $this;
+    }
+
+    /**
+     * @return Visit[]|Collection
+     */
+    public function getVisits()
+    {
+        return $this->visits;
+    }
+
+    /**
+     * @param Visit[]|Collection $visits
+     * @return $this
+     */
+    public function setVisits($visits)
+    {
+        $this->visits = $visits;
+        return $this;
+    }
+
+    /**
+     * Specify data which should be serialized to JSON
+     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+     * @return mixed data which can be serialized by <b>json_encode</b>,
+     * which is a value of any type other than a resource.
+     * @since 5.4.0
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'shortCode' => $this->shortCode,
+            'originalUrl' => $this->originalUrl,
+            'dateCreated' => isset($this->dateCreated) ? $this->dateCreated->format(\DateTime::ISO8601) : null,
+            'visitsCount' => count($this->visits),
+        ];
+    }
+}

module/Core/src/Entity/Visit.php

@@ -0,0 +1,155 @@
+<?php
+namespace Shlinkio\Shlink\Core\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Shlinkio\Shlink\Common\Entity\AbstractEntity;
+
+/**
+ * Class Visit
+ * @author
+ * @link
+ *
+ * @ORM\Entity
+ * @ORM\Table(name="visits")
+ */
+class Visit extends AbstractEntity implements \JsonSerializable
+{
+    /**
+     * @var string
+     * @ORM\Column(type="string", length=256, nullable=true)
+     */
+    protected $referer;
+    /**
+     * @var \DateTime
+     * @ORM\Column(type="datetime", nullable=false)
+     */
+    protected $date;
+    /**
+     * @var string
+     * @ORM\Column(type="string", length=256, name="remote_addr", nullable=true)
+     */
+    protected $remoteAddr;
+    /**
+     * @var string
+     * @ORM\Column(type="string", length=256, name="user_agent", nullable=true)
+     */
+    protected $userAgent;
+    /**
+     * @var ShortUrl
+     * @ORM\ManyToOne(targetEntity=ShortUrl::class)
+     * @ORM\JoinColumn(name="short_url_id", referencedColumnName="id")
+     */
+    protected $shortUrl;
+
+    public function __construct()
+    {
+        $this->date = new \DateTime();
+    }
+
+    /**
+     * @return string
+     */
+    public function getReferer()
+    {
+        return $this->referer;
+    }
+
+    /**
+     * @param string $referer
+     * @return $this
+     */
+    public function setReferer($referer)
+    {
+        $this->referer = $referer;
+        return $this;
+    }
+
+    /**
+     * @return \DateTime
+     */
+    public function getDate()
+    {
+        return $this->date;
+    }
+
+    /**
+     * @param \DateTime $date
+     * @return $this
+     */
+    public function setDate($date)
+    {
+        $this->date = $date;
+        return $this;
+    }
+
+    /**
+     * @return ShortUrl
+     */
+    public function getShortUrl()
+    {
+        return $this->shortUrl;
+    }
+
+    /**
+     * @param ShortUrl $shortUrl
+     * @return $this
+     */
+    public function setShortUrl($shortUrl)
+    {
+        $this->shortUrl = $shortUrl;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRemoteAddr()
+    {
+        return $this->remoteAddr;
+    }
+
+    /**
+     * @param string $remoteAddr
+     * @return $this
+     */
+    public function setRemoteAddr($remoteAddr)
+    {
+        $this->remoteAddr = $remoteAddr;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUserAgent()
+    {
+        return $this->userAgent;
+    }
+
+    /**
+     * @param string $userAgent
+     * @return $this
+     */
+    public function setUserAgent($userAgent)
+    {
+        $this->userAgent = $userAgent;
+        return $this;
+    }
+
+    /**
+     * Specify data which should be serialized to JSON
+     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+     * @return mixed data which can be serialized by <b>json_encode</b>,
+     * which is a value of any type other than a resource.
+     * @since 5.4.0
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'referer' => $this->referer,
+            'date' => isset($this->date) ? $this->date->format(\DateTime::ISO8601) : null,
+            'remoteAddr' => $this->remoteAddr,
+            'userAgent' => $this->userAgent,
+        ];
+    }
+}