Badger\Bundle\GameBundle\Entity\Badge

Complexity

Total Complexity

24

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	4	1
A	getTitle()	0	4	1
A	setTitle()	0	6	1
A	getDescription()	0	4	1
A	setDescription()	0	6	1
A	getImagePath()	0	4	1
A	setImagePath()	0	6	1
A	setFile()	0	4	1
A	getFile()	0	4	1
A	upload()	0	23	2
A	addTag()	0	6	1
A	setTags()	0	4	1
A	getTags()	0	4	1
A	getCompletions()	0	4	1
A	setCompletions()	0	4	1
A	getImageAbsolutePath()	0	6	2
A	getImageWebPath()	0	6	2
A	jsonSerialize()	0	9	1
A	getUploadRootDir()	0	4	1
A	getUploadDir()	0	4	1
A	__toString()	0	4	1

<?php

namespace Badger\Bundle\GameBundle\Entity;

use Badger\Component\Game\Model\BadgeInterface;
use Badger\Component\Game\Model\TagInterface;
use Doctrine\Common\Collections\ArrayCollection;
use JsonSerializable;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * Badge entity.
 *
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 */
class Badge implements BadgeInterface, JsonSerializable
{
    /** @var string */
    protected $file;

    /** @var string */
    protected $id;

    /** @var string */
    protected $title;

    /** @var string */
    protected $description;

    /** @var string */
    protected $imagePath;

    /** @var ArrayCollection */
    protected $tags;

    /** @var ArrayCollection */
    protected $completions;

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

    /**
     * {@inheritdoc}
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * {@inheritdoc}
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

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

    /**
     * {@inheritdoc}
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getImagePath()
    {
        return $this->imagePath;
    }

    /**
     * {@inheritdoc}
     */
    public function setImagePath($imagePath)
    {
        $this->imagePath = $imagePath;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function setFile(UploadedFile $file = null)
    {
        $this->file = $file;

It seems like $file can also be of type object<Symfony\Component\HttpFoundation\File\UploadedFile>. However, the property $file is declared as type string. Maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function getFile()
    {
        return $this->file;

The return type of return $this->file; (string) is incompatible with the return type declared by the interface Badger\Component\Game\Model\BadgeInterface::getFile of type Symfony\Component\HttpFoundation\File\UploadedFile.

    }

    /**
     * {@inheritdoc}
     */
    public function upload()
    {
        // the file property can be empty if the field is not required
        if (null === $this->getFile()) {
            return;
        }

        // use the original file name here but you should
        // sanitize it at least to avoid any security issues

        // move takes the target directory and then the
        // target filename to move to
        $this->getFile()->move(

The method move cannot be called on $this->getFile() (of type string).

            $this->getUploadRootDir(),
            $this->getFile()->getClientOriginalName()

The method getClientOriginalName cannot be called on $this->getFile() (of type string).

        );

        // set the path property to the filename where you've saved the file
        $this->imagePath = $this->getFile()->getClientOriginalName();

The method getClientOriginalName cannot be called on $this->getFile() (of type string).

        // clean up the file property as you won't need it anymore
        $this->file = null;
    }

    /**
     * {@inheritdoc}
     */
    public function addTag(TagInterface $tag)
    {
        $this->tags[] = $tag;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function setTags(ArrayCollection $tags)
    {
        $this->tags = $tags;
    }

    /**
     * {@inheritdoc}
     */
    public function getTags()
    {
        return $this->tags;
    }

    /**
     * {@inheritdoc}
     */
    public function getCompletions()
    {
        return $this->completions;
    }

    /**
     * {@inheritdoc}
     */
    public function setCompletions($completions)
    {
        $this->completions = $completions;
    }

    /**
     * Returns the absolute path of the image, null if no image
     *
     * @return null|string
     */
    public function getImageAbsolutePath()
    {
        return null === $this->imagePath
            ? null
            : $this->getUploadRootDir() . '/' . $this->imagePath;
    }

    /**
     * Returns the path of the image for the web, null if no image
     *
     * @return null|string
     */
    public function getImageWebPath()
    {
        return null === $this->imagePath
            ? null
            : '/' . $this->getUploadDir() . '/' . $this->imagePath;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return [
            'id'           => $this->id,
            'title'        => $this->title,
            'description'  => $this->description,
            'imageWebPath' => $this->getImageWebPath(),
        ];
    }

    /**
     * Returns the absolute directory path where uploaded documents should be saved
     *
     * @return string
     */
    protected function getUploadRootDir()
    {
        return __DIR__ . '/../../../../../web/' . $this->getUploadDir();
    }

    /**
     * Returns the path where upload files.
     *
     * Get rid of the __DIR__ so it doesn't screw up when displaying uploaded doc/image in the view.
     *
     * @return string
     */
    protected function getUploadDir()
    {
        return 'uploads/game';
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->title;
    }
}