bug #899 Improving entities contracts (yceruto)

This PR was merged into the master branch.

Discussion
----------

Improving entities contracts

For example:
```php
$post = new Post();

// ...

if (!$post->getAuthor()) { // it's null initially so it should be fine allow null return
    // ...
}

// ...

$post->setAuthor(null);
// shouldn't be allowed since the column is not null -> on flush() it'll fail anyway
```
Also it's consistent with `make:entity` command.

Commits
-------

9e1deb6 Improving entities contracts

Author: javiereguiluz

src/Entity/Comment.php

@@ -90,7 +90,7 @@ public function isLegitComment(): bool
         return !$containsInvalidCharacters;
     }
 
-    public function getId(): int
+    public function getId(): ?int
     {
         return $this->id;
     }
@@ -115,7 +115,7 @@ public function setPublishedAt(\DateTime $publishedAt): void
         $this->publishedAt = $publishedAt;
     }
 
-    public function getAuthor(): User
+    public function getAuthor(): ?User
     {
         return $this->author;
     }
@@ -130,7 +130,7 @@ public function getPost(): ?Post
         return $this->post;
     }
 
-    public function setPost(?Post $post): void
+    public function setPost(Post $post): void
     {
         $this->post = $post;
     }

src/Entity/Post.php

@@ -128,7 +128,7 @@ public function __construct()
         $this->tags = new ArrayCollection();
     }
 
-    public function getId(): int
+    public function getId(): ?int
     {
         return $this->id;
     }
@@ -138,7 +138,7 @@ public function getTitle(): ?string
         return $this->title;
     }
 
-    public function setTitle(?string $title): void
+    public function setTitle(string $title): void
     {
         $this->title = $title;
     }
@@ -148,7 +148,7 @@ public function getSlug(): ?string
         return $this->slug;
     }
 
-    public function setSlug(?string $slug): void
+    public function setSlug(string $slug): void
     {
         $this->slug = $slug;
     }
@@ -158,7 +158,7 @@ public function getContent(): ?string
         return $this->content;
     }
 
-    public function setContent(?string $content): void
+    public function setContent(string $content): void
     {
         $this->content = $content;
     }
@@ -168,17 +168,17 @@ public function getPublishedAt(): \DateTime
         return $this->publishedAt;
     }
 
-    public function setPublishedAt(?\DateTime $publishedAt): void
+    public function setPublishedAt(\DateTime $publishedAt): void
     {
         $this->publishedAt = $publishedAt;
     }
 
-    public function getAuthor(): User
+    public function getAuthor(): ?User
     {
         return $this->author;
     }
 
-    public function setAuthor(?User $author): void
+    public function setAuthor(User $author): void
     {
         $this->author = $author;
     }
@@ -188,7 +188,7 @@ public function getComments(): Collection
         return $this->comments;
     }
 
-    public function addComment(?Comment $comment): void
+    public function addComment(Comment $comment): void
     {
         $comment->setPost($this);
         if (!$this->comments->contains($comment)) {
@@ -198,7 +198,6 @@ public function addComment(?Comment $comment): void
 
     public function removeComment(Comment $comment): void
     {
-        $comment->setPost(null);
         $this->comments->removeElement($comment);
     }
 
@@ -207,12 +206,12 @@ public function getSummary(): ?string
         return $this->summary;
     }
 
-    public function setSummary(?string $summary): void
+    public function setSummary(string $summary): void
     {
         $this->summary = $summary;
     }
 
-    public function addTag(?Tag ...$tags): void
+    public function addTag(Tag ...$tags): void
     {
         foreach ($tags as $tag) {
             if (!$this->tags->contains($tag)) {

src/Entity/Tag.php

@@ -41,7 +41,7 @@ class Tag implements \JsonSerializable
      */
     private $name;
 
-    public function getId(): int
+    public function getId(): ?int
     {
         return $this->id;
     }
@@ -51,7 +51,7 @@ public function setName(string $name): void
         $this->name = $name;
     }
 
-    public function getName(): string
+    public function getName(): ?string
     {
         return $this->name;
     }

src/Entity/User.php

@@ -78,7 +78,7 @@ class User implements UserInterface, \Serializable
      */
     private $roles = [];
 
-    public function getId(): int
+    public function getId(): ?int
     {
         return $this->id;
     }
@@ -88,12 +88,12 @@ public function setFullName(string $fullName): void
         $this->fullName = $fullName;
     }
 
-    public function getFullName(): string
+    public function getFullName(): ?string
     {
         return $this->fullName;
     }
 
-    public function getUsername(): string
+    public function getUsername(): ?string
     {
         return $this->username;
     }
@@ -103,7 +103,7 @@ public function setUsername(string $username): void
         $this->username = $username;
     }
 
-    public function getEmail(): string
+    public function getEmail(): ?string
     {
         return $this->email;
     }
@@ -113,7 +113,7 @@ public function setEmail(string $email): void
         $this->email = $email;
     }
 
-    public function getPassword(): string
+    public function getPassword(): ?string
     {
         return $this->password;
     }