App\Entity\Item

Complexity

Total Complexity

31

Size/Duplication

Total Lines	419
Duplicated Lines	0 %

Test Coverage

Coverage

76.7%

Importance

Changes	1
Bugs	0	Features	0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	jsonSerialize()	0	17	1
A	setFormat()	0	5	1
A	getUrl()	0	3	1
A	getId()	0	3	1
A	setYear()	0	5	1
A	setId()	0	5	1
A	setDescription()	0	5	1
A	getStore()	0	3	1
A	addCollection()	0	3	1
A	isInCollection()	0	4	1
A	getDescription()	0	3	1
A	setAuthor()	0	5	1
A	getCategory()	0	3	1
A	getYear()	0	3	1
A	getFormat()	0	3	1
A	setName()	0	7	1
A	getName()	0	3	1
A	getAuthor()	0	3	1
A	setCategory()	0	5	1
A	setStore()	0	5	1
A	setPublisher()	0	5	1
A	getItemCollections()	0	7	2
A	setUrl()	0	5	1
A	getPublisher()	0	3	1
A	getCollections()	0	3	1
A	setUser()	0	5	1
A	__construct()	0	26	1
A	getSlug()	0	3	1
A	getUser()	0	3	1
A	getLoaned()	0	3	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\ArrayCollection;

/**
 * @ORM\Table(name="item")
 * @ORM\HasLifecycleCallbacks()
 * @ORM\Entity(repositoryClass="App\Repository\ItemRepository")
 * @Gedmo\SoftDeleteable(fieldName="deletedAt", hardDelete=false)
 */
class Item 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;

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

    /**
     * @var ?int
     * @ORM\Column(type="integer", nullable=true)
     */
    private $year;

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

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

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

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

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

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

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

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

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

    /**
     * @ORM\ManyToOne(targetEntity="Category", inversedBy="items")
     */
    private $category;

    /** 
     * @ORM\OneToMany(targetEntity="App\Entity\ItemCollection", mappedBy="item", orphanRemoval=true, cascade={"persist", "remove"}) 
     */
    protected $collections;

    /** 
     * @ORM\OneToOne(targetEntity="App\Entity\Loan", mappedBy="item") 
     */
    protected $loaned;

    /**
     * @ORM\ManyToOne(targetEntity="User", inversedBy="items")
     */
    private $user;
    
    /**
     * @param UuidInterface $id
     * @param string $name
     * @param Category $category
     * @param ?int $year
     * @param ?string $format
     * @param ?string $author
     * @param ?string $publisher
     * @param ?string $description
     * @param ?string $store
     * @param ?string $url
     * @param User $user
     * @throws \Assert\AssertionFailedException
     */
    public function __construct(
        UuidInterface $id,
        string $name,
        Category $category,
        ?int $year,
        ?string $format,
        ?string $author,
        ?string $publisher,
        ?string $description,
        ?string $store,
        ?string $url,
        User $user
        )
    {
        $this->setId($id);
        $this->setName($name);
        $this->setCategory($category);
        $this->setYear($year);
        $this->setFormat($format);
        $this->setAuthor($author);
        $this->setPublisher($publisher);
        $this->setDescription($description);
        $this->setStore($store);
        $this->setUrl($url);
        $this->setUser($user);
        $this->collections = new ArrayCollection();
    }
    
    /**
     * @param UuidInterface $id
     * @return Item
     */
    public function setId(UuidInterface $id): self
    {
        $this->id = $id;
        
        return $this;
    }

    /**
     * @return UuidInterface
     */
    public function getId(): UuidInterface
    {
        return $this->id;
    }

    /**
     * @param Category $category
     * @return Item
     */
    public function setCategory(Category $category): self
    {
        $this->category = $category;
        
        return $this;
    }

    /**
     * @return Category
     */
    public function getCategory(): Category
    {
        return $this->category;
    }

    /**
     * @param User $user
     * @return Item
     */
    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 Item
     */
    public function setName(string $name): self
    {
        Assertion::notEmpty($name, 'Item name is required');
        Assertion::maxLength($name, 255, 'Item name must less than 255 characters');
        $this->name = $name;

        return $this;
    }

    /**
     * @return ?int
     */
    public function getYear(): ?int
    {
        return $this->year;
    }

    /**
     * @param ?int $year
     * @return Item
     */
    public function setYear(?int $year): self
    {
        $this->year = $year;

        return $this;
    }

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

    /**
     * @param ?string $format
     * @return Item
     */
    public function setFormat(?string $format): self
    {
        $this->format = $format;

        return $this;
    }

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

    /**
     * @param ?string $author
     * @return Item
     */
    public function setAuthor(?string $author): self
    {
        $this->author = $author;

        return $this;
    }

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

    /**
     * @param ?string $publisher
     * @return Item
     */
    public function setPublisher(?string $publisher): self
    {
        $this->publisher = $publisher;

        return $this;
    }

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

    /**
     * @param ?string $description
     * @return Item
     */
    public function setDescription(?string $description): self
    {
        $this->description = $description;

        return $this;
    }

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

    /**
     * @param ?string $store
     * @return Item
     */
    public function setStore(?string $store): self
    {
        $this->store = $store;

        return $this;
    }

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

    /**
     * @param ?string $url
     * @return Item
     */
    public function setUrl(?string $url): self
    {
        $this->url = $url;

        return $this;
    }
    
    /**
     * @return ArrayCollection
     */
    public function getCollections()
    {
        return $this->collections;
    }
    
    /**
     * @return Loan[]
     */
    public function getLoaned()
    {
        return $this->loaned;
    }

    public function addCollection(ItemCollection $itemCollection): void
    {
        $this->collections->add($itemCollection);
    }

    /**
     * @param Collection $collection
     * @return bool
     */
    public function isInCollection(Collection $collection): bool
    {
        return $this->getCollections()->exists(function($key, $element) use ($collection){
            return $collection->getId()->equals($element->getCollection()->getId());
        });
    }
    
    /**
     *
     * @return array
     */
    public function getItemCollections(): array
    {
        $collections = [];
        foreach ($this->getCollections() as $itemCollection) {
            $collections[] = $itemCollection->getCollection();
        }
        return $collections;
    }
    
    /**
     * @return string
     */
    public function getSlug(): string
    {
        return $this->slug;
    }

    /**
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'id' => $this->getId()->toString(),
            'name' => $this->getName(),
            'categoryId' => $this->getCategory()->getId()->toString(),
            'year' => $this->getYear(),
            'format' => $this->getFormat(),
            'author' => $this->getAuthor(),
            'publisher' => $this->getPublisher(),
            'description' => $this->getDescription(),
            'store' => $this->getStore(),
            'url' => $this->getUrl(),
            'collections' => $this->getItemCollections(),
            'loaned' => $this->getLoaned(),
            'userId' => $this->getUser()->getId()->toString(),
            'slug' => $this->getSlug(),
        ];
    }
}