App\Entity\Category

Complexity

Total Complexity

16

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Test Coverage

Coverage

86.05%

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	jsonSerialize()	0	7	1
A	getDescription()	0	3	1
A	hasItems()	0	3	2
A	setId()	0	5	1
A	setUser()	0	5	1
A	getItems()	0	3	1
A	setDescription()	0	5	1
A	__construct()	0	11	1
A	checkOrderField()	0	7	2
A	getName()	0	3	1
A	getSlug()	0	3	1
A	getUser()	0	3	1
A	getId()	0	3	1
A	setName()	0	7	1

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Assert\Assertion;
use Assert\AssertionFailedException;
use App\Traits\HasTimestamps;
use Ramsey\Uuid\UuidInterface;
use Ramsey\Uuid\Uuid;
use Swagger\Annotations as SWG;
use Doctrine\Common\Collections\Collection;

This use statement conflicts with another class in this namespace, App\Entity\Collection. Consider defining an alias.

/**
 * @ORM\Table(name="category")
 * @ORM\HasLifecycleCallbacks()
 * @ORM\Entity(repositoryClass="App\Repository\CategoryRepository")
 * @Gedmo\SoftDeleteable(fieldName="deletedAt", hardDelete=false)
 */
class Category implements \JsonSerializable, UserAwareInterface
{
    use HasTimestamps;
    
    /**
     * @var UuidInterface
     * @ORM\Id()
     * @ORM\Column(type="uuid", unique=true)
     * @ORM\GeneratedValue(strategy="NONE")
     * @SWG\Property(description="UUID", type="string", readOnly=true)
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $name;

    /**
     * @ORM\Column(type="string", length=255, nullable=true)
     */
    private $description;

    /**
     * @ORM\Column(type="datetime", nullable=true)
     */
    private $deletedAt;

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

    /**
     * @Gedmo\Slug(fields={"name"})
     * @ORM\Column(length=128, unique=true)
     */
    private $slug;

    /**
     * @ORM\OneToMany(targetEntity="App\Entity\Item", mappedBy="category")
     */
    protected $items;

    /**
     * @ORM\ManyToOne(targetEntity="User", inversedBy="categories")
     */
    private $user;
    
    /**
     * @param UuidInterface $id
     * @param string $name
     * @param ?string $description
     * @param User $user
     * @throws \Assert\AssertionFailedException
     */
    public function __construct(
        UuidInterface $id,
        string $name,
        ?string $description,
        User $user
        )
    {
        $this->setId($id);
        $this->setName($name);
        $this->setDescription($description);
        $this->setUser($user);
    }

    /**
     * @param UuidInterface $id
     * @return Category
     */
    public function setId(UuidInterface $id): self
    {
        $this->id = $id;
        
        return $this;
    }
    
    /**
     * @return UuidInterface
     */
    public function getId(): UuidInterface
    {
        return $this->id;
    }

    /**
     * @param User $user
     * @return Category
     */
    public function setUser(User $user): self
    {
        $this->user = $user;
        
        return $this;
    }

    /**
     * @return User
     */
    public function getUser(): User
    {
        return $this->user;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @param string $name
     * @return Category
     */
    public function setName(string $name): self
    {
        Assertion::notEmpty($name, 'Category name is required');
        Assertion::maxLength($name, 255, 'Category name must less than 255 characters');
        $this->name = $name;

        return $this;
    }

    /**
     * @return string
     */
    public function getDescription(): ?string
    {
        return $this->description;
    }

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

    /**
     * @return Collection|null
     */
    public function getItems(): ?Collection
    {
        return $this->items;
    }
    
    /**
     * @param ?string $description
     * @return Category
     */
    public function setDescription(?string $description): self
    {
        $this->description = $description;

        return $this;
    }

    /**
     * @return bool
     */
    public function hasItems(): bool
    {
        return !($this->getItems() === null || $this->getItems()->isEmpty());
    }

    /**
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'id' => $this->getId()->toString(),
            'name' => $this->getName(),
            'description' => $this->getDescription(),
            'userId' => $this->getUser()->getId()->toString(),
        ];
    }

    public static function checkOrderField(string $orderField): bool
    {
        if (!in_array($orderField, ['name'], true)) {
            return false;
        }

        return true;
    }
}