File::toJSON() - Code Metrics - Inspection of "Entities with toJSON" - abterphp/files - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 617db1...ffc38e )

by Peter

created 2019-05-27 16:12 UTC

File::toJSON() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	5
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace AbterPhp\Files\Domain\Entities;

use AbterPhp\Framework\Domain\Entities\IStringerEntity;
use DateTime;

class File implements IStringerEntity
{
    const DATE_FORMAT = 'Y-m-d';

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

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

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

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

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

    /** @var DateTime */
    protected $uploadedAt;

    /** @var FileCategory */
    protected $category;

    /** @var bool */
    protected $writable;

    /**
     * File constructor.
     *
     * @param string            $id
     * @param string            $filesystemName
     * @param string            $publicName
     * @param string            $description
     * @param FileCategory|null $category
     * @param DateTime|null     $uploadedAt
     * @param bool              $writable
     *
     * @throws \Exception
     */
    public function __construct(
        string $id,
        string $filesystemName,
        string $publicName,
        string $description,
        FileCategory $category = null,
        DateTime $uploadedAt = null,
        bool $writable = false
    ) {
        $this->id                = $id;
        $this->filesystemName    = $filesystemName;
        $this->oldFilesystemName = $filesystemName;
        $this->publicName        = $publicName;
        $this->description       = $description;
        $this->category          = $category;
        $this->uploadedAt        = $uploadedAt ?: new DateTime();
        $this->writable          = $writable;
    }

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

    /**
     * @param string $id
     */
    public function setId($id)
    {
        $this->id = $id;
    }

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

    /**
     * @param string $filesystemName
     *
     * @return File
     */
    public function setFilesystemName(string $filesystemName): File
    {
        $this->filesystemName = $filesystemName;

        return $this;
    }

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

    /**
     * @return bool
     */
    public function isFileUploaded(): bool
    {
        return $this->oldFilesystemName !== $this->filesystemName;
    }

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

    /**
     * @param string $file
     *
     * @return File
     */
    public function setPublicName(string $publicName): File
    {
        $this->publicName = $publicName;

        return $this;
    }

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

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

        return $this;
    }

    /**
     * @return FileCategory
     */
    public function getCategory(): FileCategory
    {
        if (null === $this->category) {
            throw new \RuntimeException('Category is missing from file');
        }

        return $this->category;
    }

    /**
     * @param FileCategory $category
     *
     * @return File
     */
    public function setCategory(FileCategory $category): File
    {
        $this->category = $category;

        return $this;
    }

    /**
     * @return DateTime
     */
    public function getUploadedAt(): DateTime
    {
        return $this->uploadedAt;
    }

    /**
     * @param string $uploadedAt
     *
     * @return File
     */
    public function setUploadedAt(\DateTime $uploadedAt): File
    {
        $this->uploadedAt = $uploadedAt;

        return $this;
    }

    /**
     * @return bool
     */
    public function isWritable(): bool
    {
        return $this->writable;
    }

    /**
     * @param bool $writable
     */
    public function setWritable(bool $writable): File
    {
        $this->writable = $writable;

        return $this;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        if (!$this->publicName) {
            return '#' . $this->getId();
        }

        return $this->publicName;
    }

    /**
     * @return string
     */
    public function toJSON(): string
    {
        return json_encode(
            [
                "id" => $this->getId(),
            ]
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace AbterPhp\Files\Domain\Entities;
6
7			use AbterPhp\Framework\Domain\Entities\IStringerEntity;
8			use DateTime;
9
10			class File implements IStringerEntity
11			{
12			const DATE_FORMAT = 'Y-m-d';
13
14			/** @var string */
15			protected $id;
16
17			/** @var string */
18			protected $filesystemName;
19
20			/** @var string */
21			protected $oldFilesystemName;
22
23			/** @var string */
24			protected $publicName;
25
26			/** @var string */
27			protected $description;
28
29			/** @var DateTime */
30			protected $uploadedAt;
31
32			/** @var FileCategory */
33			protected $category;
34
35			/** @var bool */
36			protected $writable;
37
38			/**
39			* File constructor.
40			*
41			* @param string $id
42			* @param string $filesystemName
43			* @param string $publicName
44			* @param string $description
45			* @param FileCategory\|null $category
46			* @param DateTime\|null $uploadedAt
47			* @param bool $writable
48			*
49			* @throws \Exception
50			*/
51			public function __construct(
52			string $id,
53			string $filesystemName,
54			string $publicName,
55			string $description,
56			FileCategory $category = null,
57			DateTime $uploadedAt = null,
58			bool $writable = false
59			) {
60			$this->id = $id;
61			$this->filesystemName = $filesystemName;
62			$this->oldFilesystemName = $filesystemName;
63			$this->publicName = $publicName;
64			$this->description = $description;
65			$this->category = $category;
66			$this->uploadedAt = $uploadedAt ?: new DateTime();
67			$this->writable = $writable;
68			}
69
70			/**
71			* @return string
72			*/
73			public function getId()
74			{
75			return $this->id;
76			}
77
78			/**
79			* @param string $id
80			*/
81			public function setId($id)
82			{
83			$this->id = $id;
84			}
85
86			/**
87			* @return string
88			*/
89			public function getFilesystemName(): string
90			{
91			return $this->filesystemName;
92			}
93
94			/**
95			* @param string $filesystemName
96			*
97			* @return File
98			*/
99			public function setFilesystemName(string $filesystemName): File
100			{
101			$this->filesystemName = $filesystemName;
102
103			return $this;
104			}
105
106			/**
107			* @return string
108			*/
109			public function getOldFilesystemName(): string
110			{
111			return $this->oldFilesystemName;
112			}
113
114			/**
115			* @return bool
116			*/
117			public function isFileUploaded(): bool
118			{
119			return $this->oldFilesystemName !== $this->filesystemName;
120			}
121
122			/**
123			* @return string
124			*/
125			public function getPublicName(): string
126			{
127			return $this->publicName;
128			}
129
130			/**
131			* @param string $file
132			*
133			* @return File
134			*/
135			public function setPublicName(string $publicName): File
136			{
137			$this->publicName = $publicName;
138
139			return $this;
140			}
141
142			/**
143			* @return string
144			*/
145			public function getDescription(): string
146			{
147			return $this->description;
148			}
149
150			/**
151			* @param string $description
152			*
153			* @return File
154			*/
155			public function setDescription(string $description): File
156			{
157			$this->description = $description;
158
159			return $this;
160			}
161
162			/**
163			* @return FileCategory
164			*/
165			public function getCategory(): FileCategory
166			{
167			if (null === $this->category) {
168			throw new \RuntimeException('Category is missing from file');
169			}
170
171			return $this->category;
172			}
173
174			/**
175			* @param FileCategory $category
176			*
177			* @return File
178			*/
179			public function setCategory(FileCategory $category): File
180			{
181			$this->category = $category;
182
183			return $this;
184			}
185
186			/**
187			* @return DateTime
188			*/
189			public function getUploadedAt(): DateTime
190			{
191			return $this->uploadedAt;
192			}
193
194			/**
195			* @param string $uploadedAt
196			*
197			* @return File
198			*/
199			public function setUploadedAt(\DateTime $uploadedAt): File
200			{
201			$this->uploadedAt = $uploadedAt;
202
203			return $this;
204			}
205
206			/**
207			* @return bool
208			*/
209			public function isWritable(): bool
210			{
211			return $this->writable;
212			}
213
214			/**
215			* @param bool $writable
216			*/
217			public function setWritable(bool $writable): File
218			{
219			$this->writable = $writable;
220
221			return $this;
222			}
223
224			/**
225			* @return string
226			*/
227			public function __toString(): string
228			{
229			if (!$this->publicName) {
230			return '#' . $this->getId();
231			}
232
233			return $this->publicName;
234			}
235
236			/**
237			* @return string
238			*/
239			public function toJSON(): string
240			{
241			return json_encode(
242			[
243			"id" => $this->getId(),
244			]
245			);
246			}
247			}
248

abterphp / files

Push — master ( 617db1...ffc38e )

File::toJSON() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like