AbstractImage::getId() - Code Metrics - Inspection of "Form type for easier image handling" - sumocoders/Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#129)

by jelmer

created 2016-05-10 15:24 UTC

AbstractImage::getId() A

↳ Parent: AbstractImage

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

namespace SumoCoders\FrameworkCoreBundle\Entity;

use DateTime;
use Doctrine\ORM\Mapping as ORM;
use JsonSerializable;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * @ORM\MappedSuperclass
 * @ORM\HasLifecycleCallbacks
 */
abstract class AbstractImage implements JsonSerializable
{
    const FALLBACK_IMAGE = null;

    /**
     * @var int
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @var string
     * @ORM\Column(type="string", length=255, nullable=true)
     */
    protected $alt = null;

    /**
     * @var string
     * @ORM\Column(type="string", length=255, nullable=true)
     */
    protected $path = null;

    /**
     * @var UploadedFile
     * @Assert\File(
     *     maxSize = "5M",
     *     mimeTypes = {"image/jpeg", "image/gif", "image/png"},
     *     mimeTypesMessage = "file.invalid_mime_type"
     * )
     */
    private $file;

    /**
     * @var string
     */
    private $oldPath;

    /**
     * @var DateTime
     * @ORM\Column(type="datetime")
     */
    private $updatedAt;

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

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

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

    /**
     * @param string $alt
     *
     * @return self
     */
    public function setAlt($alt)
    {
        $this->alt = $alt;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getAbsolutePath()
    {
        return $this->path === null
            ? null
            : $this->getUploadRootDir() . '/' . $this->path;
    }

    /**
     * @return null|string
     */
    public function getWebPath()
    {
        $file = $this->getAbsolutePath();
        if (is_file($file) && file_exists($file)) {
            return '/' . $this->getUploadDir() . '/' . $this->path;
        }

        return static::FALLBACK_IMAGE;
    }

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

    /**
     * the dir in the web folder where the image needs to be uploaded.
     *
     * @return string
     */
    abstract protected function getUploadDir();

    /**
     * Sets file.
     *
     * @param UploadedFile $file
     */
    public function setFile(UploadedFile $file = null)
    {
        $this->updatedAt = new DateTime();

        $this->file = $file;
        // check if we have an old image path
        if (isset($this->path)) {
            // store the old name to delete after the update
            $this->oldPath = $this->path;
            $this->path = null;
        }
    }

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

    /**
     * @ORM\PrePersist()
     * @ORM\PreUpdate()
     */
    public function preUpload()
    {
        $this->updatedAt = new DateTime();

        if ($this->getFile() !== null) {
            // do whatever you want to generate a unique name
            $filename = sha1(uniqid(mt_rand(), true));
            $this->path = $filename . '.' . $this->getFile()->guessExtension();
        }
    }

    /**
     * @ORM\PostPersist()
     * @ORM\PostUpdate()
     */
    public function upload()
    {
        if ($this->getFile() === null) {
            return;
        }

        // if there is an error when moving the file, an exception will
        // be automatically thrown by move(). This will properly prevent
        // the entity from being persisted to the database on error
        $this->getFile()->move($this->getUploadRootDir(), $this->path);

        // check if we have an old image
        if (isset($this->oldPath)) {
            // delete the old image
            $oldFile = $this->getUploadRootDir() . '/' . $this->oldPath;
            if (is_file($oldFile) && file_exists($oldFile)) {
                unlink($oldFile);
            }
            // clear the $this->oldPath image path
            $this->oldPath = null;
        }
        $this->file = null;
    }

    /**
     * @ORM\PostRemove()
     */
    public function removeUpload()
    {
        $file = $this->getAbsolutePath();
        if (is_file($file) && file_exists($file)) {
            unlink($file);
        }
    }

    /**
     * Returns a string representation of the child.
     *
     * @return string
     */
    public function __toString()
    {
        return (string) $this->getWebPath();
    }

    /**
     * @return null|string
     */
    public function getFallbackImage()
    {
        return static::FALLBACK_IMAGE;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return [
            'url' => (string) $this->getWebPath(),
            'alt' => $this->getAlt(),
        ];
    }
}


1			<?php
2
3			namespace SumoCoders\FrameworkCoreBundle\Entity;
4
5			use DateTime;
6			use Doctrine\ORM\Mapping as ORM;
7			use JsonSerializable;
8			use Symfony\Component\Validator\Constraints as Assert;
9			use Symfony\Component\HttpFoundation\File\UploadedFile;
10
11			/**
12			* @ORM\MappedSuperclass
13			* @ORM\HasLifecycleCallbacks
14			*/
15			abstract class AbstractImage implements JsonSerializable
16			{
17			const FALLBACK_IMAGE = null;
18
19			/**
20			* @var int
21			* @ORM\Id
22			* @ORM\Column(type="integer")
23			* @ORM\GeneratedValue(strategy="AUTO")
24			*/
25			protected $id;
26
27			/**
28			* @var string
29			* @ORM\Column(type="string", length=255, nullable=true)
30			*/
31			protected $alt = null;
32
33			/**
34			* @var string
35			* @ORM\Column(type="string", length=255, nullable=true)
36			*/
37			protected $path = null;
38
39			/**
40			* @var UploadedFile
41			* @Assert\File(
42			* maxSize = "5M",
43			* mimeTypes = {"image/jpeg", "image/gif", "image/png"},
44			* mimeTypesMessage = "file.invalid_mime_type"
45			* )
46			*/
47			private $file;
48
49			/**
50			* @var string
51			*/
52			private $oldPath;
53
54			/**
55			* @var DateTime
56			* @ORM\Column(type="datetime")
57			*/
58			private $updatedAt;
59
60			/**
61			* @return int
62			*/
63			public function getId()
64			{
65			return $this->id;
66			}
67
68			/**
69			* @return string
70			*/
71			public function getAlt()
72			{
73			return $this->alt;
74			}
75
76			/**
77			* @return string
78			*/
79			public function getPath()
80			{
81			return $this->path;
82			}
83
84			/**
85			* @param string $alt
86			*
87			* @return self
88			*/
89			public function setAlt($alt)
90			{
91			$this->alt = $alt;
92
93			return $this;
94			}
95
96			/**
97			* @return null\|string
98			*/
99			public function getAbsolutePath()
100			{
101			return $this->path === null
102			? null
103			: $this->getUploadRootDir() . '/' . $this->path;
104			}
105
106			/**
107			* @return null\|string
108			*/
109			public function getWebPath()
110			{
111			$file = $this->getAbsolutePath();
112			if (is_file($file) && file_exists($file)) {
113			return '/' . $this->getUploadDir() . '/' . $this->path;
114			}
115
116			return static::FALLBACK_IMAGE;
117			}
118
119			/**
120			* @return string
121			*/
122			protected function getUploadRootDir()
123			{
124			// the absolute directory path where uploaded
125			// documents should be saved
126			return __DIR__ . '/../../../../web/' . $this->getUploadDir();
127			}
128
129			/**
130			* the dir in the web folder where the image needs to be uploaded.
131			*
132			* @return string
133			*/
134			abstract protected function getUploadDir();
135
136			/**
137			* Sets file.
138			*
139			* @param UploadedFile $file
140			*/
141			public function setFile(UploadedFile $file = null)
142			{
143			$this->updatedAt = new DateTime();
144
145			$this->file = $file;
146			// check if we have an old image path
147			if (isset($this->path)) {
148			// store the old name to delete after the update
149			$this->oldPath = $this->path;
150			$this->path = null;
151			}
152			}
153
154			/**
155			* Get file.
156			*
157			* @return UploadedFile
158			*/
159			public function getFile()
160			{
161			return $this->file;
162			}
163
164			/**
165			* @ORM\PrePersist()
166			* @ORM\PreUpdate()
167			*/
168			public function preUpload()
169			{
170			$this->updatedAt = new DateTime();
171
172			if ($this->getFile() !== null) {
173			// do whatever you want to generate a unique name
174			$filename = sha1(uniqid(mt_rand(), true));
175			$this->path = $filename . '.' . $this->getFile()->guessExtension();
176			}
177			}
178
179			/**
180			* @ORM\PostPersist()
181			* @ORM\PostUpdate()
182			*/
183			public function upload()
184			{
185			if ($this->getFile() === null) {
186			return;
187			}
188
189			// if there is an error when moving the file, an exception will
190			// be automatically thrown by move(). This will properly prevent
191			// the entity from being persisted to the database on error
192			$this->getFile()->move($this->getUploadRootDir(), $this->path);
193
194			// check if we have an old image
195			if (isset($this->oldPath)) {
196			// delete the old image
197			$oldFile = $this->getUploadRootDir() . '/' . $this->oldPath;
198			if (is_file($oldFile) && file_exists($oldFile)) {
199			unlink($oldFile);
200			}
201			// clear the $this->oldPath image path
202			$this->oldPath = null;
203			}
204			$this->file = null;
205			}
206
207			/**
208			* @ORM\PostRemove()
209			*/
210			public function removeUpload()
211			{
212			$file = $this->getAbsolutePath();
213			if (is_file($file) && file_exists($file)) {
214			unlink($file);
215			}
216			}
217
218			/**
219			* Returns a string representation of the child.
220			*
221			* @return string
222			*/
223			public function __toString()
224			{
225			return (string) $this->getWebPath();
226			}
227
228			/**
229			* @return null\|string
230			*/
231			public function getFallbackImage()
232			{
233			return static::FALLBACK_IMAGE;
234			}
235
236			/**
237			* {@inheritdoc}
238			*/
239			public function jsonSerialize()
240			{
241			return [
242			'url' => (string) $this->getWebPath(),
243			'alt' => $this->getAlt(),
244			];
245			}
246			}
247

sumocoders / Framework

Pull Request — master (#129)

AbstractImage::getId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like