yiisoft / yii-demo

src/Blog/Entity/Post.php

<?php

declare(strict_types=1);

namespace App\Blog\Entity;

use App\User\User;
use Cycle\Annotated\Annotation\Column;
use Cycle\Annotated\Annotation\Entity;
use Cycle\Annotated\Annotation\Relation\BelongsTo;
use Cycle\Annotated\Annotation\Relation\HasMany;
use Cycle\Annotated\Annotation\Relation\ManyToMany;
use Cycle\Annotated\Annotation\Table;
use Cycle\Annotated\Annotation\Table\Index;
use Cycle\ORM\Relation\Pivoted\PivotedCollection;
use DateTimeImmutable;
use Doctrine\Common\Collections\ArrayCollection;
use Yiisoft\Security\Random;

/**
 * @Entity(
 *     repository="App\Blog\Post\PostRepository",
 *     mapper="App\Blog\Post\PostMapper",
 *     constrain="App\Blog\Post\Scope\PublicScope"
 * )
 * @Table(
 *     indexes={
 *         @Index(columns={"public","published_at"}),
 *     }
 * )
 */
class Post
{
    /**
     * @Column(type="primary")
     */
    private ?int $id = null;

    /**
     * @Column(type="string(128)")
     */
    private string $slug;

    /**
     * @Column(type="string(255)", default="")
     */
    private string $title = '';

    /**
     * @Column(type="bool", default="false")
     */
    private bool $public = false;

    /**
     * @Column(type="text")
     */
    private string $content = '';

    /**
     * @Column(type="datetime")
     */
    private DateTimeImmutable $created_at;

    /**
     * @Column(type="datetime")
     */
    private DateTimeImmutable $updated_at;

    /**
     * @Column(type="datetime", nullable=true)
     */
    private ?DateTimeImmutable $published_at = null;

    /**
     * @Column(type="datetime", nullable=true)
     */
    private ?DateTimeImmutable $deleted_at = null;

    /**
     * @BelongsTo(target="App\User\User", nullable=false)
     *
     * @var \Cycle\ORM\Promise\Reference|User
     */
    private $user = null;
    private ?int $user_id = null;

The private property $user_id is not used, and could be removed.

    /**
     * @ManyToMany(target="App\Blog\Entity\Tag", though="PostTag", fkAction="CASCADE")
     *
     * @var PivotedCollection|Tag[]
     */
    private $tags;
    private ?int $tag_id = null;

The private property $tag_id is not used, and could be removed.

    /**
     * @HasMany(target="App\Blog\Entity\Comment")
     *
     * @var ArrayCollection|Comment[]
     */
    private $comments;

    public function __construct(string $title = '', string $content = '')
    {
        $this->title = $title;
        $this->content = $content;
        $this->created_at = new DateTimeImmutable();
        $this->updated_at = new DateTimeImmutable();
        $this->tags = new PivotedCollection();
        $this->comments = new ArrayCollection();
        $this->resetSlug();
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getSlug(): ?string
    {
        return $this->slug;
    }

    public function resetSlug(): void
    {
        $this->slug = Random::string(128);
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function setTitle(string $title): void
    {
        $this->title = $title;
    }

    public function getContent(): string
    {
        return $this->content;
    }

    public function setContent(string $content): void
    {
        $this->content = $content;
    }

    public function isPublic(): bool
    {
        return $this->public;
    }

    public function setPublic(bool $public): void
    {
        $this->public = $public;
    }

    public function getCreatedAt(): DateTimeImmutable
    {
        return $this->created_at;
    }

    public function getUpdatedAt(): DateTimeImmutable
    {
        return $this->updated_at;
    }

    public function getDeletedAt(): ?DateTimeImmutable
    {
        return $this->deleted_at;
    }

    public function setUser(User $user): void
    {
        $this->user = $user;
    }

    public function getUser(): ?User
    {
        return $this->user;

The expression return $this->user could return the type Cycle\ORM\Promise\Reference which is incompatible with the type-hinted return App\User\User|null. Consider adding an additional type-check to rule them out.

    }

    public function getPublishedAt(): ?DateTimeImmutable
    {
        return $this->published_at;
    }

    public function setPublishedAt(?DateTimeImmutable $published_at): void
    {
        $this->published_at = $published_at;
    }

    /**
     * @return Comment[]
     */
    public function getComments(): array
    {
        return $this->comments->toArray();
    }

    public function addComment(Comment $post): void
    {
        $this->comments->add($post);
    }

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

    public function addTag(Tag $post): void
    {
        $this->tags->add($post);
    }

    public function resetTags(): void
    {
        $this->tags->clear();
    }

    public function isNewRecord(): bool
    {
        return $this->getId() === null;
    }
}