]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - src/Wallabag/CoreBundle/Entity/Entry.php
manage assets through npm
[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Entity / Entry.php
index 70c1dc08b5dbe14f6abbf3fdc3cd644ac09aa0b7..ceae78b05556e4005f0c51e35e1eb93a5bf6c57a 100644 (file)
@@ -2,25 +2,38 @@
 
 namespace Wallabag\CoreBundle\Entity;
 
+use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Mapping as ORM;
+use Hateoas\Configuration\Annotation as Hateoas;
+use JMS\Serializer\Annotation\Groups;
+use JMS\Serializer\Annotation\XmlRoot;
+use JMS\Serializer\Annotation\Exclude;
+use JMS\Serializer\Annotation\VirtualProperty;
+use JMS\Serializer\Annotation\SerializedName;
 use Symfony\Component\Validator\Constraints as Assert;
+use Wallabag\UserBundle\Entity\User;
+use Wallabag\AnnotationBundle\Entity\Annotation;
 
 /**
- * Entry
+ * Entry.
  *
+ * @XmlRoot("entry")
  * @ORM\Entity(repositoryClass="Wallabag\CoreBundle\Repository\EntryRepository")
- * @ORM\Table(name="entry")
+ * @ORM\Table(name="`entry`")
  * @ORM\HasLifecycleCallbacks()
- *
+ * @Hateoas\Relation("self", href = "expr('/api/entries/' ~ object.getId())")
  */
 class Entry
 {
+    /** @Serializer\XmlAttribute */
     /**
-     * @var integer
+     * @var int
      *
      * @ORM\Column(name="id", type="integer")
      * @ORM\Id
      * @ORM\GeneratedValue(strategy="AUTO")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $id;
 
@@ -28,6 +41,8 @@ class Entry
      * @var string
      *
      * @ORM\Column(name="title", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $title;
 
@@ -36,34 +51,39 @@ class Entry
      *
      * @Assert\NotBlank()
      * @ORM\Column(name="url", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $url;
 
     /**
-     * @var boolean
+     * @var bool
+     *
+     * @Exclude
      *
      * @ORM\Column(name="is_archived", type="boolean")
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $isArchived = false;
 
     /**
-     * @var boolean
+     * @var bool
+     *
+     * @Exclude
      *
      * @ORM\Column(name="is_starred", type="boolean")
-     */
-    private $isStarred = false;
-
-    /**
-     * @var boolean
      *
-     * @ORM\Column(name="is_deleted", type="boolean")
+     * @Groups({"entries_for_user", "export_all"})
      */
-    private $isDeleted = false;
+    private $isStarred = false;
 
     /**
      * @var string
      *
      * @ORM\Column(name="content", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $content;
 
@@ -71,6 +91,8 @@ class Entry
      * @var date
      *
      * @ORM\Column(name="created_at", type="datetime")
+     *
+     * @Groups({"export_all"})
      */
     private $createdAt;
 
@@ -78,34 +100,43 @@ class Entry
      * @var date
      *
      * @ORM\Column(name="updated_at", type="datetime")
+     *
+     * @Groups({"export_all"})
      */
     private $updatedAt;
 
     /**
-     * @var string
+     * @ORM\OneToMany(targetEntity="Wallabag\AnnotationBundle\Entity\Annotation", mappedBy="entry", cascade={"persist", "remove"})
+     * @ORM\JoinTable
      *
-     * @ORM\Column(name="user_id", type="decimal", precision=10, scale=0, nullable=true)
+     * @Groups({"entries_for_user", "export_all"})
      */
-    private $userId;
+    private $annotations;
 
     /**
      * @var string
      *
-     * @ORM\Column(name="comments", type="text", nullable=true)
+     * @ORM\Column(name="mimetype", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
-    private $comments;
+    private $mimetype;
 
     /**
      * @var string
      *
-     * @ORM\Column(name="mimetype", type="text", nullable=true)
+     * @ORM\Column(name="language", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
-    private $mimetype;
+    private $language;
 
     /**
-     * @var integer
+     * @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;
 
@@ -113,20 +144,67 @@ class Entry
      * @var string
      *
      * @ORM\Column(name="domain_name", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
      */
     private $domainName;
 
     /**
-     * @var boolean
+     * @var string
+     *
+     * @ORM\Column(name="preview_picture", type="text", nullable=true)
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $previewPicture;
+
+    /**
+     * @var bool
      *
      * @ORM\Column(name="is_public", type="boolean", nullable=true, options={"default" = false})
+     *
+     * @Groups({"export_all"})
      */
     private $isPublic;
 
     /**
-     * Get id
+     * @Exclude
+     *
+     * @ORM\ManyToOne(targetEntity="Wallabag\UserBundle\Entity\User", inversedBy="entries")
      *
-     * @return integer
+     * @Groups({"export_all"})
+     */
+    private $user;
+
+    /**
+     * @ORM\ManyToMany(targetEntity="Tag", inversedBy="entries", cascade={"persist"})
+     * @ORM\JoinTable(
+     *  name="entry_tag",
+     *  joinColumns={
+     *      @ORM\JoinColumn(name="entry_id", referencedColumnName="id")
+     *  },
+     *  inverseJoinColumns={
+     *      @ORM\JoinColumn(name="tag_id", referencedColumnName="id")
+     *  }
+     * )
+     *
+     * @Groups({"entries_for_user", "export_all"})
+     */
+    private $tags;
+
+    /*
+     * @param User     $user
+     */
+    public function __construct(User $user)
+    {
+        $this->user = $user;
+        $this->tags = new ArrayCollection();
+    }
+
+    /**
+     * Get id.
+     *
+     * @return int
      */
     public function getId()
     {
@@ -134,9 +212,10 @@ class Entry
     }
 
     /**
-     * Set title
+     * Set title.
+     *
+     * @param string $title
      *
-     * @param  string $title
      * @return Entry
      */
     public function setTitle($title)
@@ -147,7 +226,7 @@ class Entry
     }
 
     /**
-     * Get title
+     * Get title.
      *
      * @return string
      */
@@ -157,9 +236,10 @@ class Entry
     }
 
     /**
-     * Set url
+     * Set url.
+     *
+     * @param string $url
      *
-     * @param  string $url
      * @return Entry
      */
     public function setUrl($url)
@@ -170,7 +250,7 @@ class Entry
     }
 
     /**
-     * Get url
+     * Get url.
      *
      * @return string
      */
@@ -180,9 +260,10 @@ class Entry
     }
 
     /**
-     * Set isArchived
+     * Set isArchived.
+     *
+     * @param bool $isArchived
      *
-     * @param  string $isArchived
      * @return Entry
      */
     public function setArchived($isArchived)
@@ -193,15 +274,25 @@ class Entry
     }
 
     /**
-     * Get isArchived
+     * 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;
@@ -210,9 +301,10 @@ class Entry
     }
 
     /**
-     * Set isStarred
+     * Set isStarred.
+     *
+     * @param bool $isStarred
      *
-     * @param  string $isStarred
      * @return Entry
      */
     public function setStarred($isStarred)
@@ -223,15 +315,25 @@ class Entry
     }
 
     /**
-     * Get isStarred
+     * 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;
@@ -240,9 +342,10 @@ class Entry
     }
 
     /**
-     * Set content
+     * Set content.
+     *
+     * @param string $content
      *
-     * @param  string $content
      * @return Entry
      */
     public function setContent($content)
@@ -253,7 +356,7 @@ class Entry
     }
 
     /**
-     * Get content
+     * Get content.
      *
      * @return string
      */
@@ -263,46 +366,42 @@ class Entry
     }
 
     /**
-     * Set userId
-     *
-     * @param  string $userId
-     * @return Entry
+     * @return User
      */
-    public function setUserId($userId)
+    public function getUser()
     {
-        $this->userId = $userId;
-
-        return $this;
+        return $this->user;
     }
 
     /**
-     * Get userId
-     *
-     * @return string
+     * @VirtualProperty
+     * @SerializedName("user_name")
      */
-    public function getUserId()
+    public function getUserName()
     {
-        return $this->userId;
+        return $this->user->getUserName();
     }
 
     /**
-     * @return string
+     * @VirtualProperty
+     * @SerializedName("user_email")
      */
-    public function isDeleted()
+    public function getUserEmail()
     {
-        return $this->isDeleted;
+        return $this->user->getEmail();
     }
 
     /**
-     * @param string $isDeleted
+     * @VirtualProperty
+     * @SerializedName("user_id")
      */
-    public function setDeleted($isDeleted)
+    public function getUserId()
     {
-        $this->isDeleted = $isDeleted;
+        return $this->user->getId();
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getCreatedAt()
     {
@@ -331,19 +430,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;
     }
 
     /**
@@ -395,7 +494,7 @@ class Entry
     }
 
     /**
-     * @return boolean
+     * @return bool
      */
     public function isPublic()
     {
@@ -403,10 +502,97 @@ class Entry
     }
 
     /**
-     * @param boolean $isPublic
+     * @param bool $isPublic
      */
-    public function setPublic($isPublic)
+    public function setIsPublic($isPublic)
     {
         $this->isPublic = $isPublic;
     }
+
+    /**
+     * @return ArrayCollection<Tag>
+     */
+    public function getTags()
+    {
+        return $this->tags;
+    }
+
+    /**
+     * @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;
+    }
 }