File::populateInfo() - Code Metrics - Inspection of "File handler" - Stadly/FileWaiter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 35dc73...c63c35 )

by Magnar Ovedal

created 2021-09-10 10:13 UTC

File::populateInfo() A

↳ Parent: File

Complexity

Conditions	6
Paths	32

Size

Total Lines	20
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	10
c	1
b	0
f	0
nc	32
nop	1
dl	0
loc	20
ccs	11
cts	11
cp	1
crap	6
rs	9.2222

<?php

declare(strict_types=1);

namespace Stadly\FileWaiter;

use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use Stadly\FileWaiter\Exception\StreamCouldNotBeOpened;
use Stadly\Http\Header\Value\Date;
use Stadly\Http\Header\Value\EntityTag\EntityTag;
use Stadly\Http\Header\Value\MediaType\MediaType;

/**
 * Class for handling files.
 */
final class File
{
    public const NO_INFO = 0;
    public const FILE_NAME = 1;
    public const FILE_SIZE = 2;
    public const MEDIA_TYPE = 4;
    public const LAST_MODIFIED_DATE = 8;
    public const ENTITY_TAG = 16;
    public const ALL_INFO = 32 - 1;

    /**
     * @var Adapter Adapter used to access the file in its file system.
     */
    private $adapter;

    /**
     * @var string|null File name.
     */
    private $fileName = null;

    /**
     * @var int|null File size.
     */
    private $fileSize = null;

    /**
     * @var MediaType|null Media type of the file.
     */
    private $mediaType = null;

    /**
     * @var Date|null Date when the file was last modified.
     */
    private $lastModifiedDate = null;

    /**
     * @var EntityTag|null Entity tag for the file.
     */
    private $entityTag = null;

    /**
     * Constructor.
     *
     * @param Adapter $adapter Adapter used to access the file in its file system.
     * @param int $populateInfo Bit mask specifying which information to populate from the file's adapter.
     */
    public function __construct(Adapter $adapter, int $populateInfo = self::ALL_INFO)
    {
        $this->adapter = $adapter;
        $this->populateInfo($populateInfo);
    }

    /**
     * @return StreamInterface File stream that can be used to read from the file.
     * @throws StreamCouldNotBeOpened If the file stream could not be opened.
     */
    public function getFileStream(): StreamInterface
    {
        return $this->adapter->getFileStream();
    }

    /**
     * Populate information retrieved from the file's adapter.
     *
     * @param int $whichInfo Bit mask specifying which information to populate from the file's adapter.
     */
    public function populateInfo(int $whichInfo = self::ALL_INFO): void
    {
        if ((self::FILE_NAME & $whichInfo) !== 0) {
            $this->setFileName($this->adapter->getFileName());
        }

        if ((self::FILE_SIZE & $whichInfo) !== 0) {
            $this->setFileSize($this->adapter->getFileSize());
        }

        if ((self::MEDIA_TYPE & $whichInfo) !== 0) {
            $this->setMediaType($this->adapter->getMediaType());
        }

        if ((self::LAST_MODIFIED_DATE & $whichInfo) !== 0) {
            $this->setLastModifiedDate($this->adapter->getLastModifiedDate());
        }

        if ((self::ENTITY_TAG & $whichInfo) !== 0) {
            $this->setEntityTag($this->adapter->getEntityTag());
        }
    }

    /**
     * @return string|null File name, or null if not set.
     */
    public function getFileName(): ?string
    {
        return $this->fileName;
    }

    /**
     * @param string|null $fileName File name.
     */
    public function setFileName(?string $fileName): void
    {
        $this->fileName = $fileName;
    }

    /**
     * @return int|null File size, or null if not set.
     */
    public function getFileSize(): ?int
    {
        return $this->fileSize;
    }

    /**
     * @param int|null $fileSize File size.
     */
    public function setFileSize(?int $fileSize): void
    {
        // File size must be non-negative.
        if ($fileSize < 0) {
            throw new InvalidArgumentException('Invalid file size: ' . $fileSize);
        }

        $this->fileSize = $fileSize;
    }

    /**
     * @return MediaType|null Media type of the file, or null if not set.
     */
    public function getMediaType(): ?MediaType
    {
        return $this->mediaType;
    }

    /**
     * @param MediaType|null $mediaType Media type of the file.
     */
    public function setMediaType(?MediaType $mediaType): void
    {
        $this->mediaType = $mediaType;
    }

    /**
     * @return Date|null Date when the file was last modified, or null if not set.
     */
    public function getLastModifiedDate(): ?Date
    {
        return $this->lastModifiedDate;
    }

    /**
     * @param Date|null $date Date when the file was last modified.
     */
    public function setLastModifiedDate(?Date $date): void
    {
        $this->lastModifiedDate = $date;
    }

    /**
     * @return EntityTag|null Entity tag for the file, or null if not set.
     */
    public function getEntityTag(): ?EntityTag
    {
        return $this->entityTag;
    }

    /**
     * @param EntityTag|null $entityTag Entity tag for the file.
     */
    public function setEntityTag(?EntityTag $entityTag): void
    {
        $this->entityTag = $entityTag;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Stadly\FileWaiter;
6
7		use InvalidArgumentException;
8		use Psr\Http\Message\StreamInterface;
9		use Stadly\FileWaiter\Exception\StreamCouldNotBeOpened;
10		use Stadly\Http\Header\Value\Date;
11		use Stadly\Http\Header\Value\EntityTag\EntityTag;
12		use Stadly\Http\Header\Value\MediaType\MediaType;
13
14		/**
15		* Class for handling files.
16		*/
17		final class File
18		{
19		public const NO_INFO = 0;
20		public const FILE_NAME = 1;
21		public const FILE_SIZE = 2;
22		public const MEDIA_TYPE = 4;
23		public const LAST_MODIFIED_DATE = 8;
24		public const ENTITY_TAG = 16;
25		public const ALL_INFO = 32 - 1;
26
27		/**
28		* @var Adapter Adapter used to access the file in its file system.
29		*/
30		private $adapter;
31
32		/**
33		* @var string\|null File name.
34		*/
35		private $fileName = null;
36
37		/**
38		* @var int\|null File size.
39		*/
40		private $fileSize = null;
41
42		/**
43		* @var MediaType\|null Media type of the file.
44		*/
45		private $mediaType = null;
46
47		/**
48		* @var Date\|null Date when the file was last modified.
49		*/
50		private $lastModifiedDate = null;
51
52		/**
53		* @var EntityTag\|null Entity tag for the file.
54		*/
55		private $entityTag = null;
56
57		/**
58		* Constructor.
59		*
60		* @param Adapter $adapter Adapter used to access the file in its file system.
61		* @param int $populateInfo Bit mask specifying which information to populate from the file's adapter.
62		*/
63	7	public function __construct(Adapter $adapter, int $populateInfo = self::ALL_INFO)
64		{
65	7	$this->adapter = $adapter;
66	7	$this->populateInfo($populateInfo);
67	7	}
68
69		/**
70		* @return StreamInterface File stream that can be used to read from the file.
71		* @throws StreamCouldNotBeOpened If the file stream could not be opened.
72		*/
73	1	public function getFileStream(): StreamInterface
74		{
75	1	return $this->adapter->getFileStream();
76		}
77
78		/**
79		* Populate information retrieved from the file's adapter.
80		*
81		* @param int $whichInfo Bit mask specifying which information to populate from the file's adapter.
82		*/
83	7	public function populateInfo(int $whichInfo = self::ALL_INFO): void
84		{
85	7	if ((self::FILE_NAME & $whichInfo) !== 0) {
86	2	$this->setFileName($this->adapter->getFileName());
87		}
88
89	7	if ((self::FILE_SIZE & $whichInfo) !== 0) {
90	2	$this->setFileSize($this->adapter->getFileSize());
91		}
92
93	7	if ((self::MEDIA_TYPE & $whichInfo) !== 0) {
94	2	$this->setMediaType($this->adapter->getMediaType());
95		}
96
97	7	if ((self::LAST_MODIFIED_DATE & $whichInfo) !== 0) {
98	2	$this->setLastModifiedDate($this->adapter->getLastModifiedDate());
99		}
100
101	7	if ((self::ENTITY_TAG & $whichInfo) !== 0) {
102	2	$this->setEntityTag($this->adapter->getEntityTag());
103		}
104	7	}
105
106		/**
107		* @return string\|null File name, or null if not set.
108		*/
109	1	public function getFileName(): ?string
110		{
111	1	return $this->fileName;
112		}
113
114		/**
115		* @param string\|null $fileName File name.
116		*/
117	2	public function setFileName(?string $fileName): void
118		{
119	2	$this->fileName = $fileName;
120	2	}
121
122		/**
123		* @return int\|null File size, or null if not set.
124		*/
125	1	public function getFileSize(): ?int
126		{
127	1	return $this->fileSize;
128		}
129
130		/**
131		* @param int\|null $fileSize File size.
132		*/
133	4	public function setFileSize(?int $fileSize): void
134		{
135		// File size must be non-negative.
136	4	if ($fileSize < 0) {
137	1	throw new InvalidArgumentException('Invalid file size: ' . $fileSize);
138		}
139
140	4	$this->fileSize = $fileSize;
141	4	}
142
143		/**
144		* @return MediaType\|null Media type of the file, or null if not set.
145		*/
146	1	public function getMediaType(): ?MediaType
147		{
148	1	return $this->mediaType;
149		}
150
151		/**
152		* @param MediaType\|null $mediaType Media type of the file.
153		*/
154	2	public function setMediaType(?MediaType $mediaType): void
155		{
156	2	$this->mediaType = $mediaType;
157	2	}
158
159		/**
160		* @return Date\|null Date when the file was last modified, or null if not set.
161		*/
162	1	public function getLastModifiedDate(): ?Date
163		{
164	1	return $this->lastModifiedDate;
165		}
166
167		/**
168		* @param Date\|null $date Date when the file was last modified.
169		*/
170	2	public function setLastModifiedDate(?Date $date): void
171		{
172	2	$this->lastModifiedDate = $date;
173	2	}
174
175		/**
176		* @return EntityTag\|null Entity tag for the file, or null if not set.
177		*/
178	1	public function getEntityTag(): ?EntityTag
179		{
180	1	return $this->entityTag;
181		}
182
183		/**
184		* @param EntityTag\|null $entityTag Entity tag for the file.
185		*/
186	2	public function setEntityTag(?EntityTag $entityTag): void
187		{
188	2	$this->entityTag = $entityTag;
189	2	}
190		}
191

Stadly / FileWaiter

Push — main ( 35dc73...c63c35 )

File::populateInfo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like