X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=src%2FWallabag%2FCoreBundle%2FEntity%2FEntry.php;h=5e608f05d909a57d99ab0b8a4977721d510e5ae9;hb=f808b01692a835673f328d7221ba8c212caa9b61;hp=f139bbacc0ce80500249e2d7dd956cd7de93beec;hpb=82d6d9cb06a1486e2e3b05fa6ce857b3b8655180;p=github%2Fwallabag%2Fwallabag.git

diff --git a/src/Wallabag/CoreBundle/Entity/Entry.php b/src/Wallabag/CoreBundle/Entity/Entry.php
index f139bbac..581e8906 100644
--- a/src/Wallabag/CoreBundle/Entity/Entry.php
+++ b/src/Wallabag/CoreBundle/Entity/Entry.php
@@ -4,16 +4,29 @@ namespace Wallabag\CoreBundle\Entity;
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Mapping as ORM;
-use Symfony\Component\Validator\Constraints as Assert;
 use Hateoas\Configuration\Annotation as Hateoas;
+use JMS\Serializer\Annotation\Exclude;
+use JMS\Serializer\Annotation\Groups;
+use JMS\Serializer\Annotation\SerializedName;
+use JMS\Serializer\Annotation\VirtualProperty;
 use JMS\Serializer\Annotation\XmlRoot;
+use Symfony\Component\Validator\Constraints as Assert;
+use Wallabag\AnnotationBundle\Entity\Annotation;
+use Wallabag\UserBundle\Entity\User;
 
 /**
  * Entry.
  *
  * @XmlRoot("entry")
  * @ORM\Entity(repositoryClass="Wallabag\CoreBundle\Repository\EntryRepository")
- * @ORM\Table
+ * @ORM\Table(
+ *     name="`entry`",
+ *     options={"collate"="utf8mb4_unicode_ci", "charset"="utf8mb4"},
+ *     indexes={
+ *         @ORM\Index(name="created_at", columns={"created_at"}),
+ *         @ORM\Index(name="uid", columns={"uid"})
+ *     }
+ * )
  * @ORM\HasLifecycleCallbacks()
  * @Hateoas\Relation("self", href = "expr('/api/entries/' ~ object.getId())")
  */
@@ -26,13 +39,26 @@ class Entry
      * @ORM\Column(name="id", type="integer")
      * @ORM\Id
      * @ORM\GeneratedValue(strategy="AUTO")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $id;
 
+    /**
+     * @var string
+     *
+     * @ORM\Column(name="uid", type="string", length=23, nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $uid;
+
     /**
      * @var string
      *
      * @ORM\Column(name="title", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $title;
 
@@ -41,20 +67,30 @@ class Entry
      *
      * @Assert\NotBlank()
      * @ORM\Column(name="url", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $url;
 
     /**
      * @var bool
      *
+     * @Exclude
+     *
      * @ORM\Column(name="is_archived", type="boolean")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $isArchived = false;
 
     /**
      * @var bool
      *
+     * @Exclude
+     *
      * @ORM\Column(name="is_starred", type="boolean")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $isStarred = false;
 
@@ -62,41 +98,79 @@ class Entry
      * @var string
      *
      * @ORM\Column(name="content", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $content;
 
     /**
-     * @var date
+     * @var \DateTime
      *
      * @ORM\Column(name="created_at", type="datetime")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $createdAt;
 
     /**
-     * @var date
+     * @var \DateTime
      *
      * @ORM\Column(name="updated_at", type="datetime")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $updatedAt;
 
     /**
-     * @var string
+     * @var \DateTime
+     *
+     * @ORM\Column(name="published_at", type="datetime", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $publishedAt;
+
+    /**
+     * @var array
+     *
+     * @ORM\Column(name="published_by", type="array", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $publishedBy;
+
+    /**
+     * @ORM\OneToMany(targetEntity="Wallabag\AnnotationBundle\Entity\Annotation", mappedBy="entry", cascade={"persist", "remove"})
+     * @ORM\JoinTable
      *
-     * @ORM\Column(name="comments", type="text", nullable=true)
+     * @Groups({"entries_for_user", "export_all"})
      */
-    private $comments;
+    private $annotations;
 
     /**
      * @var string
      *
      * @ORM\Column(name="mimetype", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $mimetype;
 
+    /**
+     * @var string
+     *
+     * @ORM\Column(name="language", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $language;
+
     /**
      * @var int
      *
-     * @ORM\Column(name="reading_type", type="integer", nullable=true)
+     * @ORM\Column(name="reading_time", type="integer", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $readingTime;
 
@@ -104,24 +178,58 @@ class Entry
      * @var string
      *
      * @ORM\Column(name="domain_name", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $domainName;
 
     /**
-     * @var bool
+     * @var string
+     *
+     * @ORM\Column(name="preview_picture", type="text", nullable=true)
      *
-     * @ORM\Column(name="is_public", type="boolean", nullable=true, options={"default" = false})
+     * @Groups({"entries_for_user", "export_all"})
      */
-    private $isPublic;
+    private $previewPicture;
 
     /**
-     * @ORM\ManyToOne(targetEntity="User", inversedBy="entries")
+     * @var string
+     *
+     * @ORM\Column(name="http_status", type="string", length=3, nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $httpStatus;
+
+    /**
+     * @var array
+     *
+     * @ORM\Column(name="headers", type="array", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $headers;
+
+    /**
+     * @Exclude
+     *
+     * @ORM\ManyToOne(targetEntity="Wallabag\UserBundle\Entity\User", inversedBy="entries")
+     *
+     * @Groups({"export_all"})
      */
     private $user;
 
     /**
      * @ORM\ManyToMany(targetEntity="Tag", inversedBy="entries", cascade={"persist"})
-     * @ORM\JoinTable
+     * @ORM\JoinTable(
+     *  name="entry_tag",
+     *  joinColumns={
+     *      @ORM\JoinColumn(name="entry_id", referencedColumnName="id", onDelete="cascade")
+     *  },
+     *  inverseJoinColumns={
+     *      @ORM\JoinColumn(name="tag_id", referencedColumnName="id", onDelete="cascade")
+     *  }
+     * )
      */
     private $tags;
 
@@ -195,7 +303,7 @@ class Entry
     /**
      * Set isArchived.
      *
-     * @param string $isArchived
+     * @param bool $isArchived
      *
      * @return Entry
      */
@@ -209,13 +317,23 @@ class Entry
     /**
      * Get isArchived.
      *
-     * @return string
+     * @return bool
      */
     public function isArchived()
     {
         return $this->isArchived;
     }
 
+    /**
+     * @VirtualProperty
+     * @SerializedName("is_archived")
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    public function is_Archived()
+    {
+        return (int) $this->isArchived();
+    }
+
     public function toggleArchive()
     {
         $this->isArchived = $this->isArchived() ^ 1;
@@ -226,7 +344,7 @@ class Entry
     /**
      * Set isStarred.
      *
-     * @param string $isStarred
+     * @param bool $isStarred
      *
      * @return Entry
      */
@@ -240,13 +358,23 @@ class Entry
     /**
      * Get isStarred.
      *
-     * @return string
+     * @return bool
      */
     public function isStarred()
     {
         return $this->isStarred;
     }
 
+    /**
+     * @VirtualProperty
+     * @SerializedName("is_starred")
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    public function is_Starred()
+    {
+        return (int) $this->isStarred();
+    }
+
     public function toggleStar()
     {
         $this->isStarred = $this->isStarred() ^ 1;
@@ -287,7 +415,49 @@ class Entry
     }
 
     /**
-     * @return string
+     * @VirtualProperty
+     * @SerializedName("user_name")
+     */
+    public function getUserName()
+    {
+        return $this->user->getUserName();
+    }
+
+    /**
+     * @VirtualProperty
+     * @SerializedName("user_email")
+     */
+    public function getUserEmail()
+    {
+        return $this->user->getEmail();
+    }
+
+    /**
+     * @VirtualProperty
+     * @SerializedName("user_id")
+     */
+    public function getUserId()
+    {
+        return $this->user->getId();
+    }
+
+    /**
+     * Set created_at.
+     * Only used when importing data from an other service.
+     *
+     * @param \DateTime $createdAt
+     *
+     * @return Entry
+     */
+    public function setCreatedAt(\DateTime $createdAt)
+    {
+        $this->createdAt = $createdAt;
+
+        return $this;
+    }
+
+    /**
+     * @return \DateTime
      */
     public function getCreatedAt()
     {
@@ -295,7 +465,7 @@ class Entry
     }
 
     /**
-     * @return string
+     * @return \DateTime
      */
     public function getUpdatedAt()
     {
@@ -308,7 +478,7 @@ class Entry
      */
     public function timestamps()
     {
-        if (is_null($this->createdAt)) {
+        if (null === $this->createdAt) {
             $this->createdAt = new \DateTime();
         }
 
@@ -316,19 +486,19 @@ class Entry
     }
 
     /**
-     * @return string
+     * @return ArrayCollection<Annotation>
      */
-    public function getComments()
+    public function getAnnotations()
     {
-        return $this->comments;
+        return $this->annotations;
     }
 
     /**
-     * @param string $comments
+     * @param Annotation $annotation
      */
-    public function setComments($comments)
+    public function setAnnotation(Annotation $annotation)
     {
-        $this->comments = $comments;
+        $this->annotations[] = $annotation;
     }
 
     /**
@@ -380,40 +550,232 @@ class Entry
     }
 
     /**
+     * @return ArrayCollection
+     */
+    public function getTags()
+    {
+        return $this->tags;
+    }
+
+    /**
+     * @VirtualProperty
+     * @SerializedName("tags")
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    public function getSerializedTags()
+    {
+        $data = [];
+        foreach ($this->tags as $tag) {
+            $data[] = $tag->getLabel();
+        }
+
+        return $data;
+    }
+
+    /**
+     * @param Tag $tag
+     */
+    public function addTag(Tag $tag)
+    {
+        if ($this->tags->contains($tag)) {
+            return;
+        }
+
+        // check if tag already exist but has not yet be persisted
+        // it seems that the previous condition with `contains()` doesn't check that case
+        foreach ($this->tags as $existingTag) {
+            if ($existingTag->getLabel() === $tag->getLabel()) {
+                return;
+            }
+        }
+
+        $this->tags->add($tag);
+        $tag->addEntry($this);
+    }
+
+    public function removeTag(Tag $tag)
+    {
+        if (!$this->tags->contains($tag)) {
+            return;
+        }
+
+        $this->tags->removeElement($tag);
+        $tag->removeEntry($this);
+    }
+
+    /**
+     * Set previewPicture.
+     *
+     * @param string $previewPicture
+     *
+     * @return Entry
+     */
+    public function setPreviewPicture($previewPicture)
+    {
+        $this->previewPicture = $previewPicture;
+
+        return $this;
+    }
+
+    /**
+     * Get previewPicture.
+     *
+     * @return string
+     */
+    public function getPreviewPicture()
+    {
+        return $this->previewPicture;
+    }
+
+    /**
+     * Set language.
+     *
+     * @param string $language
+     *
+     * @return Entry
+     */
+    public function setLanguage($language)
+    {
+        $this->language = $language;
+
+        return $this;
+    }
+
+    /**
+     * Get language.
+     *
+     * @return string
+     */
+    public function getLanguage()
+    {
+        return $this->language;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUid()
+    {
+        return $this->uid;
+    }
+
+    /**
+     * @param string $uid
+     *
+     * @return Entry
+     */
+    public function setUid($uid)
+    {
+        $this->uid = $uid;
+
+        return $this;
+    }
+
+    public function generateUid()
+    {
+        if (null === $this->uid) {
+            // @see http://blog.kevingomez.fr/til/2015/07/26/why-is-uniqid-slow/ for true parameter
+            $this->uid = uniqid('', true);
+        }
+    }
+
+    public function cleanUid()
+    {
+        $this->uid = null;
+    }
+
+    /**
+     * Used in the entries filter so it's more explicit for the end user than the uid.
+     * Also used in the API.
+     *
+     * @VirtualProperty
+     * @SerializedName("is_public")
+     * @Groups({"entries_for_user"})
+     *
      * @return bool
      */
     public function isPublic()
     {
-        return $this->isPublic;
+        return null !== $this->uid;
     }
 
     /**
-     * @param bool $isPublic
+     * @return string
      */
-    public function setIsPublic($isPublic)
+    public function getHttpStatus()
     {
-        $this->isPublic = $isPublic;
+        return $this->httpStatus;
     }
 
     /**
-     * @return ArrayCollection<Tag>
+     * @param string $httpStatus
+     *
+     * @return Entry
      */
-    public function getTags()
+    public function setHttpStatus($httpStatus)
     {
-        return $this->tags;
+        $this->httpStatus = $httpStatus;
+
+        return $this;
     }
 
     /**
-     * @param Tag $tag
+     * @return \Datetime
      */
-    public function addTag(Tag $tag)
+    public function getPublishedAt()
     {
-        $this->tags[] = $tag;
-        $tag->addEntry($this);
+        return $this->publishedAt;
     }
 
-    public function removeTag(Tag $tag)
+    /**
+     * @param \Datetime $publishedAt
+     *
+     * @return Entry
+     */
+    public function setPublishedAt(\Datetime $publishedAt)
     {
-        $this->tags->removeElement($tag);
+        $this->publishedAt = $publishedAt;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getPublishedBy()
+    {
+        return $this->publishedBy;
+    }
+
+    /**
+     * @param array $publishedBy
+     *
+     * @return Entry
+     */
+    public function setPublishedBy($publishedBy)
+    {
+        $this->publishedBy = $publishedBy;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getHeaders()
+    {
+        return $this->headers;
+    }
+
+    /**
+     * @param array $headers
+     *
+     * @return Entry
+     */
+    public function setHeaders($headers)
+    {
+        $this->headers = $headers;
+
+        return $this;
     }
 }