Storage::getName() - Code Metrics - anime-db/catalog-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Storage::getName() A
last analyzed 2017-06-23 22:09 UTC

↳ Parent: Storage

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * AnimeDb package.
 *
 * @author    Peter Gribanov <[email protected]>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/GPL-3.0 GPL v3
 */

namespace AnimeDb\Bundle\CatalogBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Doctrine\Common\Collections\ArrayCollection;
use Symfony\Component\Validator\ExecutionContextInterface;

/**
 * Storage of item files.
 *
 * @ORM\Entity
 * @ORM\Table(name="storage")
 * @Assert\Callback(methods={"isPathValid"})
 * @ORM\HasLifecycleCallbacks
 * @ORM\Entity(repositoryClass="AnimeDb\Bundle\CatalogBundle\Repository\Storage")
 *
 * @author  Peter Gribanov <[email protected]>
 */
class Storage
{
    /**
     * Type folder on computer (local/network).
     *
     * @var string
     */
    const TYPE_FOLDER = 'folder';

    /**
     * Type external storage (HDD/Flash/SD).
     *
     * @var string
     */
    const TYPE_EXTERNAL = 'external';

    /**
     * Type external storage read-only (CD/DVD).
     *
     * @var string
     */
    const TYPE_EXTERNAL_R = 'external-r';

    /**
     * Type video storage (DVD/BD/VHS).
     *
     * @var string
     */
    const TYPE_VIDEO = 'video';

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

    /**
     * @ORM\Column(type="string", length=128)
     * @Assert\NotBlank()
     *
     * @var string
     */
    protected $name = '';

    /**
     * @ORM\Column(type="text", nullable=true)
     *
     * @var string
     */
    protected $description = '';

    /**
     * @ORM\Column(type="string", length=16)
     * @Assert\Choice(callback = "getTypes")
     *
     * @var string
     */
    protected $type = '';

    /**
     * Path on computer.
     *
     * @ORM\Column(type="text", nullable=true)
     *
     * @var string
     */
    protected $path = '';

    /**
     * Date last update storage.
     *
     * @ORM\Column(type="datetime")
     *
     * @var \DateTime
     */
    protected $date_update;

    /**
     * Date of files last modified.
     *
     * @ORM\Column(type="datetime")
     *
     * @var \DateTime
     */
    protected $file_modified;

    /**
     * @ORM\OneToMany(targetEntity="Item", mappedBy="storage")
     *
     * @var ArrayCollection
     */
    protected $items;

    /**
     * List old paths.
     *
     * @var array
     */
    protected $old_paths = [];

    /**
     * @var array
     */
    protected static $type_names = [
        self::TYPE_FOLDER,
        self::TYPE_EXTERNAL,
        self::TYPE_EXTERNAL_R,
        self::TYPE_VIDEO,
    ];

    /**
     * @var array
     */
    protected static $type_titles = [
        self::TYPE_FOLDER => 'Folder on computer (local/network)',
        self::TYPE_EXTERNAL => 'External storage (HDD/Flash/SD)',
        self::TYPE_EXTERNAL_R => 'External storage read-only (CD/DVD)',
        self::TYPE_VIDEO => 'Video storage (DVD/BD/VHS)',
    ];

    public function __construct()
    {
        $this->items = new ArrayCollection();
        $this->date_update = new \DateTime();
    }

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

    /**
     * @param string $name
     *
     * @return Storage
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

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

    /**
     * @param string $description
     *
     * @return Storage
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

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

    /**
     * @param string $path
     *
     * @return Storage
     */
    public function setPath($path)
    {
        if ($this->path) {
            $this->old_paths[] = $this->path;
        }
        $this->path = $path;

        return $this;
    }

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

    /**
     * @return array
     */
    public function getOldPaths()
    {
        return $this->old_paths;
    }

    /**
     * @param Item $item
     *
     * @return Storage
     */
    public function addItem(Item $item)

    {
        if (!$this->items->contains($item)) {
            $this->items->add($item);
            $item->setStorage($this);
        }

        return $this;
    }

    /**
     * @param Item $item
     *
     * @return Storage
     */
    public function removeItem(Item $item)

    {
        if ($this->items->contains($item)) {
            $this->items->removeElement($item);
            $item->setStorage(null);
        }

        return $this;
    }

    /**
     * @return ArrayCollection
     */
    public function getItems()
    {
        return $this->items;
    }

    /**
     * @param string $type
     *
     * @return Storage
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

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

    /**
     * @return array
     */
    public static function getTypes()
    {
        return self::$type_names;
    }

    /**
     * @return array
     */
    public static function getTypeTitles()
    {
        return self::$type_titles;
    }

    /**
     * Get title for current type.
     *
     * @return string
     */
    public function getTypeTitle()
    {
        return isset(self::$type_titles[$this->type]) ? self::$type_titles[$this->type] : '';
    }

    /**
     * Get types storage allow write.
     *
     * @return array
     */
    public static function getTypesWritable()
    {
        return [self::TYPE_FOLDER, self::TYPE_EXTERNAL];
    }

    /**
     * Get types storage allow read.
     *
     * @return array
     */
    public static function getTypesReadable()
    {
        return [self::TYPE_FOLDER, self::TYPE_EXTERNAL, self::TYPE_EXTERNAL_R];
    }

    /**
     * Is path required to fill for current type of storage.
     *
     * @return bool
     */
    public function isPathRequired()
    {
        return $this->isWritable();
    }

    /**
     * @return bool
     */
    public function isWritable()
    {
        return in_array($this->getType(), self::getTypesWritable());
    }

    /**
     * @return bool
     */
    public function isReadable()
    {
        return in_array($this->getType(), self::getTypesReadable());
    }

    /**
     * Is valid path for current type.
     *
     * @param ExecutionContextInterface $context
     */
    public function isPathValid(ExecutionContextInterface $context)
    {
        if ($this->isPathRequired() && !$this->getPath()) {
            $context->addViolationAt('path', 'Path is required to fill for current type of storage');

        }
    }

    /**
     * @param \DateTime $date_update
     *
     * @return Storage
     */
    public function setDateUpdate(\DateTime $date_update)
    {
        $this->date_update = clone $date_update;

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getDateUpdate()
    {
        return $this->date_update;
    }

    /**
     * @param \DateTime $file_modified
     *
     * @return Storage
     */
    public function setFileModified(\DateTime $file_modified)
    {
        $this->file_modified = clone $file_modified;

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getFileModified()
    {
        return $this->file_modified;
    }

    /**
     * @ORM\PreUpdate
     */
    public function doChangeDateUpdate()
    {
        $this->date_update = new \DateTime();
    }

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


1			<?php
2			/**
3			* AnimeDb package.
4			*
5			* @author Peter Gribanov <[email protected]>
6			* @copyright Copyright (c) 2011, Peter Gribanov
7			* @license http://opensource.org/licenses/GPL-3.0 GPL v3
8			*/
9
10			namespace AnimeDb\Bundle\CatalogBundle\Entity;
11
12			use Doctrine\ORM\Mapping as ORM;
13			use Symfony\Component\Validator\Constraints as Assert;
14			use Doctrine\Common\Collections\ArrayCollection;
15			use Symfony\Component\Validator\ExecutionContextInterface;
16
17			/**
18			* Storage of item files.
19			*
20			* @ORM\Entity
21			* @ORM\Table(name="storage")
22			* @Assert\Callback(methods={"isPathValid"})
23			* @ORM\HasLifecycleCallbacks
24			* @ORM\Entity(repositoryClass="AnimeDb\Bundle\CatalogBundle\Repository\Storage")
25			*
26			* @author Peter Gribanov <[email protected]>
27			*/
28			class Storage
29			{
30			/**
31			* Type folder on computer (local/network).
32			*
33			* @var string
34			*/
35			const TYPE_FOLDER = 'folder';
36
37			/**
38			* Type external storage (HDD/Flash/SD).
39			*
40			* @var string
41			*/
42			const TYPE_EXTERNAL = 'external';
43
44			/**
45			* Type external storage read-only (CD/DVD).
46			*
47			* @var string
48			*/
49			const TYPE_EXTERNAL_R = 'external-r';
50
51			/**
52			* Type video storage (DVD/BD/VHS).
53			*
54			* @var string
55			*/
56			const TYPE_VIDEO = 'video';
57
58			/**
59			* @ORM\Id
60			* @ORM\GeneratedValue
61			* @ORM\Column(type="integer")
62			*
63			* @var int
64			*/
65			protected $id = 0;
66
67			/**
68			* @ORM\Column(type="string", length=128)
69			* @Assert\NotBlank()
70			*
71			* @var string
72			*/
73			protected $name = '';
74
75			/**
76			* @ORM\Column(type="text", nullable=true)
77			*
78			* @var string
79			*/
80			protected $description = '';
81
82			/**
83			* @ORM\Column(type="string", length=16)
84			* @Assert\Choice(callback = "getTypes")
85			*
86			* @var string
87			*/
88			protected $type = '';
89
90			/**
91			* Path on computer.
92			*
93			* @ORM\Column(type="text", nullable=true)
94			*
95			* @var string
96			*/
97			protected $path = '';
98
99			/**
100			* Date last update storage.
101			*
102			* @ORM\Column(type="datetime")
103			*
104			* @var \DateTime
105			*/
106			protected $date_update;
107
108			/**
109			* Date of files last modified.
110			*
111			* @ORM\Column(type="datetime")
112			*
113			* @var \DateTime
114			*/
115			protected $file_modified;
116
117			/**
118			* @ORM\OneToMany(targetEntity="Item", mappedBy="storage")
119			*
120			* @var ArrayCollection
121			*/
122			protected $items;
123
124			/**
125			* List old paths.
126			*
127			* @var array
128			*/
129			protected $old_paths = [];
130
131			/**
132			* @var array
133			*/
134			protected static $type_names = [
135			self::TYPE_FOLDER,
136			self::TYPE_EXTERNAL,
137			self::TYPE_EXTERNAL_R,
138			self::TYPE_VIDEO,
139			];
140
141			/**
142			* @var array
143			*/
144			protected static $type_titles = [
145			self::TYPE_FOLDER => 'Folder on computer (local/network)',
146			self::TYPE_EXTERNAL => 'External storage (HDD/Flash/SD)',
147			self::TYPE_EXTERNAL_R => 'External storage read-only (CD/DVD)',
148			self::TYPE_VIDEO => 'Video storage (DVD/BD/VHS)',
149			];
150
151	149		public function __construct()
152			{
153	149		$this->items = new ArrayCollection();
154	149		$this->date_update = new \DateTime();
155	149		}
156
157			/**
158			* @return int
159			*/
160	1		public function getId()
161			{
162	1		return $this->id;
163			}
164
165			/**
166			* @param string $name
167			*
168			* @return Storage
169			*/
170	2		public function setName($name)
171			{
172	2		$this->name = $name;
173
174	2		return $this;
175			}
176
177			/**
178			* @return string
179			*/
180	2		public function getName()
181			{
182	2		return $this->name;
183			}
184
185			/**
186			* @param string $description
187			*
188			* @return Storage
189			*/
190	1		public function setDescription($description)
191			{
192	1		$this->description = $description;
193
194	1		return $this;
195			}
196
197			/**
198			* @return string
199			*/
200	1		public function getDescription()
201			{
202	1		return $this->description;
203			}
204
205			/**
206			* @param string $path
207			*
208			* @return Storage
209			*/
210	12		public function setPath($path)
211			{
212	12		if ($this->path) {
213	1		$this->old_paths[] = $this->path;
214	1		}
215	12		$this->path = $path;
216
217	12		return $this;
218			}
219
220			/**
221			* @return string
222			*/
223	5		public function getPath()
224			{
225	5		return $this->path;
226			}
227
228			/**
229			* @return array
230			*/
231	1		public function getOldPaths()
232			{
233	1		return $this->old_paths;
234			}
235
236			/**
237			* @param Item $item
238			*
239			* @return Storage
240			*/
241	1	View Code Duplication	public function addItem(Item $item)
			0 ignored issues – show Duplication introduced 2016-01-02 16:13 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
242			{
243	1		if (!$this->items->contains($item)) {
244	1		$this->items->add($item);
245	1		$item->setStorage($this);
246	1		}
247
248	1		return $this;
249			}
250
251			/**
252			* @param Item $item
253			*
254			* @return Storage
255			*/
256	1	View Code Duplication	public function removeItem(Item $item)
			0 ignored issues – show Duplication introduced 2016-01-02 16:13 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
257			{
258	1		if ($this->items->contains($item)) {
259	1		$this->items->removeElement($item);
260	1		$item->setStorage(null);
261	1		}
262
263	1		return $this;
264			}
265
266			/**
267			* @return ArrayCollection
268			*/
269	1		public function getItems()
270			{
271	1		return $this->items;
272			}
273
274			/**
275			* @param string $type
276			*
277			* @return Storage
278			*/
279	31		public function setType($type)
280			{
281	31		$this->type = $type;
282
283	31		return $this;
284			}
285
286			/**
287			* @return string
288			*/
289	26		public function getType()
290			{
291	26		return $this->type;
292			}
293
294			/**
295			* @return array
296			*/
297	1		public static function getTypes()
298			{
299	1		return self::$type_names;
300			}
301
302			/**
303			* @return array
304			*/
305	5		public static function getTypeTitles()
306			{
307	5		return self::$type_titles;
308			}
309
310			/**
311			* Get title for current type.
312			*
313			* @return string
314			*/
315	5		public function getTypeTitle()
316			{
317	5		return isset(self::$type_titles[$this->type]) ? self::$type_titles[$this->type] : '';
318			}
319
320			/**
321			* Get types storage allow write.
322			*
323			* @return array
324			*/
325	21		public static function getTypesWritable()
326			{
327	21		return [self::TYPE_FOLDER, self::TYPE_EXTERNAL];
328			}
329
330			/**
331			* Get types storage allow read.
332			*
333			* @return array
334			*/
335	6		public static function getTypesReadable()
336			{
337	6		return [self::TYPE_FOLDER, self::TYPE_EXTERNAL, self::TYPE_EXTERNAL_R];
338			}
339
340			/**
341			* Is path required to fill for current type of storage.
342			*
343			* @return bool
344			*/
345	15		public function isPathRequired()
346			{
347	15		return $this->isWritable();
348			}
349
350			/**
351			* @return bool
352			*/
353	20		public function isWritable()
354			{
355	20		return in_array($this->getType(), self::getTypesWritable());
356			}
357
358			/**
359			* @return bool
360			*/
361	5		public function isReadable()
362			{
363	5		return in_array($this->getType(), self::getTypesReadable());
364			}
365
366			/**
367			* Is valid path for current type.
368			*
369			* @param ExecutionContextInterface $context
370			*/
371	10		public function isPathValid(ExecutionContextInterface $context)
372			{
373	10		if ($this->isPathRequired() && !$this->getPath()) {
374	2		$context->addViolationAt('path', 'Path is required to fill for current type of storage');
			0 ignored issues – show Deprecated Code introduced 2016-03-24 14:11 UTC by Report Bug Copy Issue Report The method `Symfony\Component\Valida...rface::addViolationAt()` has been deprecated with message: since version 2.5, to be removed in 3.0. Use {@link Context\ExecutionContextInterface::buildViolation()} instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
375	2		}
376	10		}
377
378			/**
379			* @param \DateTime $date_update
380			*
381			* @return Storage
382			*/
383	2		public function setDateUpdate(\DateTime $date_update)
384			{
385	2		$this->date_update = clone $date_update;
386
387	2		return $this;
388			}
389
390			/**
391			* @return \DateTime
392			*/
393	2		public function getDateUpdate()
394			{
395	2		return $this->date_update;
396			}
397
398			/**
399			* @param \DateTime $file_modified
400			*
401			* @return Storage
402			*/
403	1		public function setFileModified(\DateTime $file_modified)
404			{
405	1		$this->file_modified = clone $file_modified;
406
407	1		return $this;
408			}
409
410			/**
411			* @return \DateTime
412			*/
413	1		public function getFileModified()
414			{
415	1		return $this->file_modified;
416			}
417
418			/**
419			* @ORM\PreUpdate
420			*/
421	1		public function doChangeDateUpdate()
422			{
423	1		$this->date_update = new \DateTime();
424	1		}
425
426			/**
427			* @return string
428			*/
429	1		public function __toString()
430			{
431	1		return $this->getName();
432			}
433			}
434

anime-db / catalog-bundle

Storage::getName() A last analyzed 2017-06-23 22:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Storage::getName() A
last analyzed 2017-06-23 22:09 UTC