shlink/module/Core/src/Entity/ShortUrl.php

<?php
declare(strict_types=1);

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;
use Shlinkio\Shlink\Core\Repository\ShortUrlRepository;

/**
 * Class ShortUrl
 * @author
 * @link
 *
 * @ORM\Entity(repositoryClass=ShortUrlRepository::class)
 * @ORM\Table(name="short_urls")
 */
class ShortUrl extends AbstractEntity
{
    /**
     * @var string
     * @ORM\Column(name="original_url", type="string", nullable=false, length=1024)
     */
    private $originalUrl;
    /**
     * @var string
     * @ORM\Column(
     *     name="short_code",
     *     type="string",
     *     nullable=false,
     *     length=255,
     *     unique=true
     * )
     */
    private $shortCode;
    /**
     * @var \DateTime
     * @ORM\Column(name="date_created", type="datetime")
     */
    private $dateCreated;
    /**
     * @var Collection|Visit[]
     * @ORM\OneToMany(targetEntity=Visit::class, mappedBy="shortUrl", fetch="EXTRA_LAZY")
     */
    private $visits;
    /**
     * @var Collection|Tag[]
     * @ORM\ManyToMany(targetEntity=Tag::class, cascade={"persist"})
     * @ORM\JoinTable(name="short_urls_in_tags", joinColumns={
     *     @ORM\JoinColumn(name="short_url_id", referencedColumnName="id")
     * }, inverseJoinColumns={
     *     @ORM\JoinColumn(name="tag_id", referencedColumnName="id")
     * })
     */
    private $tags;
    /**
     * @var \DateTime
     * @ORM\Column(name="valid_since", type="datetime", nullable=true)
     */
    private $validSince;
    /**
     * @var \DateTime
     * @ORM\Column(name="valid_until", type="datetime", nullable=true)
     */
    private $validUntil;
    /**
     * @var integer
     * @ORM\Column(name="max_visits", type="integer", nullable=true)
     */
    private $maxVisits;

    public function __construct()
    {
        $this->shortCode = '';
        $this->dateCreated = new \DateTime();
        $this->visits = new ArrayCollection();
        $this->tags = new ArrayCollection();
    }

    public function getLongUrl(): string
    {
        return $this->originalUrl;
    }

    public function setLongUrl(string $longUrl): self
    {
        $this->originalUrl = $longUrl;
        return $this;
    }

    /**
     * @deprecated Use getLongUrl() instead
     */
    public function getOriginalUrl(): string
    {
        return $this->getLongUrl();
    }

    /**
     * @deprecated Use setLongUrl() instead
     */
    public function setOriginalUrl(string $originalUrl): self
    {
        return $this->setLongUrl($originalUrl);
    }

    public function getShortCode(): string
    {
        return $this->shortCode;
    }

    public function setShortCode(string $shortCode): self
    {
        $this->shortCode = $shortCode;
        return $this;
    }

    public function getDateCreated(): \DateTime
    {
        return $this->dateCreated;
    }

    public function setDateCreated(\DateTime $dateCreated): self
    {
        $this->dateCreated = $dateCreated;
        return $this;
    }

    /**
     * @return Collection|Tag[]
     */
    public function getTags(): Collection
    {
        return $this->tags;
    }

    /**
     * @param Collection|Tag[] $tags
     */
    public function setTags(Collection $tags): self
    {
        $this->tags = $tags;
        return $this;
    }

    public function addTag(Tag $tag): self
    {
        $this->tags->add($tag);
        return $this;
    }

    public function getValidSince(): ?\DateTime
    {
        return $this->validSince;
    }

    public function setValidSince(?\DateTime $validSince): self
    {
        $this->validSince = $validSince;
        return $this;
    }

    public function getValidUntil(): ?\DateTime
    {
        return $this->validUntil;
    }

    public function setValidUntil(?\DateTime $validUntil): self
    {
        $this->validUntil = $validUntil;
        return $this;
    }

    public function getVisitsCount(): int
    {
        return \count($this->visits);
    }

    /**
     * @param Collection|Visit[] $visits
     * @return ShortUrl
     * @internal
     */
    public function setVisits(Collection $visits): self
    {
        $this->visits = $visits;
        return $this;
    }

    public function getMaxVisits(): ?int
    {
        return $this->maxVisits;
    }

    public function setMaxVisits(?int $maxVisits): self
    {
        $this->maxVisits = $maxVisits;
        return $this;
    }

    public function maxVisitsReached(): bool
    {
        return $this->maxVisits !== null && $this->getVisitsCount() >= $this->maxVisits;
    }
}