Add annotation with proper types for setter and getter methods

Author: bocharsky-bw

src/AppBundle/Entity/Comment.php

@@ -83,6 +83,8 @@ public function __construct()
 
     /**
      * @Assert\IsTrue(message = "comment.is_spam")
+     *
+     * @return bool
      */
     public function isLegitComment()
     {
@@ -91,46 +93,73 @@ public function isLegitComment()
         return !$containsInvalidCharacters;
     }
 
+    /**
+     * @return int
+     */
     public function getId()
     {
         return $this->id;
     }
 
+    /**
+     * @return string
+     */
     public function getContent()
     {
         return $this->content;
     }
 
+    /**
+     * @param string $content
+     */
     public function setContent($content)
     {
         $this->content = $content;
     }
 
+    /**
+     * @return string
+     */
     public function getAuthorEmail()
     {
         return $this->authorEmail;
     }
 
+    /**
+     * @param string $authorEmail
+     */
     public function setAuthorEmail($authorEmail)
     {
         $this->authorEmail = $authorEmail;
     }
 
+    /**
+     * @return \DateTime
+     */
     public function getPublishedAt()
     {
         return $this->publishedAt;
     }
 
+    /**
+     * @param \DateTime $publishedAt
+     */
     public function setPublishedAt(\DateTime $publishedAt)
     {
         $this->publishedAt = $publishedAt;
     }
 
+    /**
+     * @return Post
+     */
     public function getPost()
     {
         return $this->post;
     }
 
+    /**
+     * @param Post $post
+     */
     public function setPost(Post $post)
     {
         $this->post = $post;

src/AppBundle/Entity/Post.php

@@ -103,46 +103,73 @@ public function __construct()
         $this->comments = new ArrayCollection();
     }
 
+    /**
+     * @return int
+     */
     public function getId()
     {
         return $this->id;
     }
 
+    /**
+     * @return string
+     */
     public function getTitle()
     {
         return $this->title;
     }
 
+    /**
+     * @param string $title
+     */
     public function setTitle($title)
     {
         $this->title = $title;
     }
 
+    /**
+     * @return string
+     */
     public function getSlug()
     {
         return $this->slug;
     }
 
+    /**
+     * @param string $slug
+     */
     public function setSlug($slug)
     {
         $this->slug = $slug;
     }
 
+    /**
+     * @return string
+     */
     public function getContent()
     {
         return $this->content;
     }
 
+    /**
+     * @param string $content
+     */
     public function setContent($content)
     {
         $this->content = $content;
     }
 
+    /**
+     * @return string
+     */
     public function getAuthorEmail()
     {
         return $this->authorEmail;
     }
 
+    /**
+     * @param string $authorEmail
+     */
     public function setAuthorEmail($authorEmail)
     {
         $this->authorEmail = $authorEmail;
@@ -160,37 +187,58 @@ public function isAuthor(User $user)
         return $user->getEmail() === $this->getAuthorEmail();
     }
 
+    /**
+     * @return \DateTime
+     */
     public function getPublishedAt()
     {
         return $this->publishedAt;
     }
 
+    /**
+     * @param \DateTime $publishedAt
+     */
     public function setPublishedAt(\DateTime $publishedAt)
     {
         $this->publishedAt = $publishedAt;
     }
 
+    /**
+     * @return Comment[]|ArrayCollection
+     */
     public function getComments()
     {
         return $this->comments;
     }
 
+    /**
+     * @param Comment $comment
+     */
     public function addComment(Comment $comment)
     {
         $this->comments->add($comment);
         $comment->setPost($this);
     }
 
+    /**
+     * @param Comment $comment
+     */
     public function removeComment(Comment $comment)
     {
         $this->comments->removeElement($comment);
     }
 
+    /**
+     * @return string
+     */
     public function getSummary()
     {
         return $this->summary;
     }
 
+    /**
+     * @param string $summary
+     */
     public function setSummary($summary)
     {
         $this->summary = $summary;

src/AppBundle/Entity/User.php

@@ -57,6 +57,9 @@ class User implements UserInterface
      */
     private $roles = [];
 
+    /**
+     * @return int
+     */
     public function getId()
     {
         return $this->id;
@@ -70,16 +73,25 @@ public function getUsername()
         return $this->username;
     }
 
+    /**
+     * @param string $username
+     */
     public function setUsername($username)
     {
         $this->username = $username;
     }
 
+    /**
+     * @return string
+     */
     public function getEmail()
     {
         return $this->email;
     }
 
+    /**
+     * @param string $email
+     */
     public function setEmail($email)
     {
         $this->email = $email;
@@ -93,13 +105,18 @@ public function getPassword()
         return $this->password;
     }
 
+    /**
+     * @param string $password
+     */
     public function setPassword($password)
     {
         $this->password = $password;
     }
 
     /**
      * Returns the roles or permissions granted to the user for security.
+     *
+     * @return array
      */
     public function getRoles()
     {
@@ -113,25 +130,32 @@ public function getRoles()
         return array_unique($roles);
     }
 
+    /**
+     * @param array $roles
+     */
     public function setRoles(array $roles)
     {
         $this->roles = $roles;
     }
 
     /**
      * Returns the salt that was originally used to encode the password.
+     *
+     * {@inheritdoc}
      */
     public function getSalt()
     {
         // See "Do you need to use a Salt?" at http://symfony.com/doc/current/cookbook/security/entity_provider.html
         // we're using bcrypt in security.yml to encode the password, so
         // the salt value is built-in and you don't have to generate one
 
-        return;
+        return null;
     }
 
     /**
      * Removes sensitive data from the user.
+     *
+     * @return void
      */
     public function eraseCredentials()
     {