FileBucket::bufferContentType() - Code Metrics - Inspection of "Added withAutoContentType method (#8)" - roxblnfk/smart-stream - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 51d800...1482cb )

by Aleksei

created 2020-08-03 15:38 UTC

FileBucket::bufferContentType() A

↳ Parent: FileBucket

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.0261

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	1
dl	0
loc	10
ccs	6
cts	7
cp	0.8571
crap	3.0261
rs	10
c	0
b	0
f	0

<?php

namespace roxblnfk\SmartStream\Data;

use InvalidArgumentException;
use SplFileInfo;
use Yiisoft\Http\Header;

class FileBucket extends DataBucket
{
    public const TYPE_OCTET_STREAM = 'application/octet-stream';

    protected const DISPOSITION_INLINE = 'inline';
    protected const DISPOSITION_ATTACHMENT = 'attachment';

    protected const IS_CONVERTABLE = false;
    protected ?string $contentType = null;
    protected ?string $contentDisposition = null;
    protected ?string $fileName = null;

    /**
     * FileBucket constructor.
     * @param string|resource|SplFileInfo $data
     * @param null|string $contentType
     * @param null|string $fileName
     * @throws \Exception
     */
    public function __construct($data, string $contentType = null, string $fileName = null)
    {
        switch (true) {
            case $data instanceof SplFileInfo:
                if (!$data->isFile()) {
                    throw new InvalidArgumentException('File does not exist or is not a file.');
                }
                $fileName = $fileName ?? $data->getFilename();
                // $contentType = $contentType ?? $this->fileContentType($data->getPathname());
                parent::__construct($data);
                break;
            case is_string($data):
            case is_resource($data):
                parent::__construct($data);
                break;
            default:
                throw new InvalidArgumentException(
                    'The $data parameter must be a resource, a string or an instance of SplFileInfo.'
                );
        }

        if ($contentType !== null) {
            $this->setContentType($contentType);
        }
        if ($fileName !== null) {
            $this->setAttachment($fileName);
        }
    }

    public static function createFromPath(string $filePath, string $contentType = null, string $fileName = null): self
    {
        return new static(new SplFileInfo($filePath), $contentType, $fileName);
    }

    public function getContentType(): ?string
    {
        return $this->contentType;
    }
    public function getFileName(): ?string
    {
        return $this->fileName;
    }
    public function hasDisposition(): bool
    {
        return $this->contentDisposition !== null;
    }
    public function isAttachment(): bool
    {
        return $this->contentDisposition === self::DISPOSITION_ATTACHMENT;
    }
    public function isInline(): bool
    {
        return $this->contentDisposition === self::DISPOSITION_INLINE;
    }

    public function withAttachment(string $filename = null): self
    {
        $clone = clone $this;
        $clone->setAttachment($filename);
        return $clone;
    }
    public function withContentType(?string $contentType): self
    {
        $clone = clone $this;
        $clone->setContentType($contentType);
        return $clone;
    }
    public function withInline(): self
    {
        $clone = clone $this;
        $clone->setInline();
        return $clone;
    }
    public function withoutDisposition(): self
    {
        $clone = clone $this;
        $clone->contentDisposition = null;
        $clone->setDispositionHeader();
        return $clone;
    }
    public function withAutoContentType(): self
    {
        $clone = clone $this;
        $type = null;
        if ($clone->data instanceof SplFileInfo) {
            $type = $clone->fileContentType($clone->data->getPathname());
        } elseif (is_string($clone->data)) {
            $type = $clone->bufferContentType($clone->data);
        }
        $clone->setContentType($type);
        return $clone;
    }

    protected function setContentType(?string $contentType): void
    {
        $this->contentType = $contentType;
        $this->setHeader(Header::CONTENT_TYPE, $contentType);
    }
    protected function setInline(): void
    {
        $this->contentDisposition = self::DISPOSITION_INLINE;
        $this->setDispositionHeader();
    }
    final protected function setAttachment(?string $fileName): void
    {
        $this->contentDisposition = self::DISPOSITION_ATTACHMENT;
        $this->fileName = $fileName;
        $this->setDispositionHeader();
    }
    final protected function setDispositionHeader(): void
    {
        $headerBody = ($this->contentDisposition === self::DISPOSITION_ATTACHMENT && $this->fileName !== null)
            ? sprintf(
                '%s; filename="%s"; filename*=UTF-8\'\'%s',
                $this->contentDisposition,
                preg_replace('/[\x00-\x1F\x7F\"]/', ' ', $this->fileName),
                rawurlencode($this->fileName)
            )
            : $this->contentDisposition;
        $this->setHeader(Header::CONTENT_DISPOSITION, $headerBody);
    }
    private function fileContentType(string $filePath): ?string
    {
        if (!is_file($filePath) || !is_readable($filePath)) {
            return null;
        }
        if (function_exists('finfo_open')) {
            $finfo = finfo_open(FILEINFO_MIME_TYPE);
            $result = finfo_file($finfo, $filePath);
            if (is_string($result)) {
                return $result;
            }
        }
        $result = $result ?? (function_exists('mime_content_type') ? mime_content_type($filePath) : null);
        return is_string($result) ? $result : null;
    }
    private function bufferContentType(string $buffer): ?string
    {
        if (function_exists('finfo_open')) {
            $finfo = finfo_open(FILEINFO_MIME_TYPE);
            $result = finfo_buffer($finfo, $buffer);
            if (is_string($result)) {

                return $result;
            }
        }
        return null;
    }
}


1		<?php
2
3		namespace roxblnfk\SmartStream\Data;
4
5		use InvalidArgumentException;
6		use SplFileInfo;
7		use Yiisoft\Http\Header;
8
9		class FileBucket extends DataBucket
10		{
11		public const TYPE_OCTET_STREAM = 'application/octet-stream';
12
13		protected const DISPOSITION_INLINE = 'inline';
14		protected const DISPOSITION_ATTACHMENT = 'attachment';
15
16		protected const IS_CONVERTABLE = false;
17		protected ?string $contentType = null;
18		protected ?string $contentDisposition = null;
19		protected ?string $fileName = null;
20
21		/**
22		* FileBucket constructor.
23		* @param string\|resource\|SplFileInfo $data
24		* @param null\|string $contentType
25		* @param null\|string $fileName
26		* @throws \Exception
27		*/
28	40	public function __construct($data, string $contentType = null, string $fileName = null)
29		{
30		switch (true) {
31	40	case $data instanceof SplFileInfo:
32	5	if (!$data->isFile()) {
33	2	throw new InvalidArgumentException('File does not exist or is not a file.');
34		}
35	3	$fileName = $fileName ?? $data->getFilename();
36		// $contentType = $contentType ?? $this->fileContentType($data->getPathname());
37	3	parent::__construct($data);
38	3	break;
39	35	case is_string($data):
40	2	case is_resource($data):
41	34	parent::__construct($data);
42	34	break;
43		default:
44	1	throw new InvalidArgumentException(
45	1	'The $data parameter must be a resource, a string or an instance of SplFileInfo.'
46		);
47		}
48
49	37	if ($contentType !== null) {
50	2	$this->setContentType($contentType);
51		}
52	37	if ($fileName !== null) {
53	4	$this->setAttachment($fileName);
54		}
55	37	}
56
57	4	public static function createFromPath(string $filePath, string $contentType = null, string $fileName = null): self
58		{
59	4	return new static(new SplFileInfo($filePath), $contentType, $fileName);
60		}
61
62	12	public function getContentType(): ?string
63		{
64	12	return $this->contentType;
65		}
66	9	public function getFileName(): ?string
67		{
68	9	return $this->fileName;
69		}
70	4	public function hasDisposition(): bool
71		{
72	4	return $this->contentDisposition !== null;
73		}
74	6	public function isAttachment(): bool
75		{
76	6	return $this->contentDisposition === self::DISPOSITION_ATTACHMENT;
77		}
78	4	public function isInline(): bool
79		{
80	4	return $this->contentDisposition === self::DISPOSITION_INLINE;
81		}
82
83	14	public function withAttachment(string $filename = null): self
84		{
85	14	$clone = clone $this;
86	14	$clone->setAttachment($filename);
87	14	return $clone;
88		}
89	4	public function withContentType(?string $contentType): self
90		{
91	4	$clone = clone $this;
92	4	$clone->setContentType($contentType);
93	4	return $clone;
94		}
95	5	public function withInline(): self
96		{
97	5	$clone = clone $this;
98	5	$clone->setInline();
99	5	return $clone;
100		}
101	1	public function withoutDisposition(): self
102		{
103	1	$clone = clone $this;
104	1	$clone->contentDisposition = null;
105	1	$clone->setDispositionHeader();
106	1	return $clone;
107		}
108	3	public function withAutoContentType(): self
109		{
110	3	$clone = clone $this;
111	3	$type = null;
112	3	if ($clone->data instanceof SplFileInfo) {
113	1	$type = $clone->fileContentType($clone->data->getPathname());
114	2	} elseif (is_string($clone->data)) {
115	2	$type = $clone->bufferContentType($clone->data);
116		}
117	3	$clone->setContentType($type);
118	3	return $clone;
119		}
120
121	8	protected function setContentType(?string $contentType): void
122		{
123	8	$this->contentType = $contentType;
124	8	$this->setHeader(Header::CONTENT_TYPE, $contentType);
125	8	}
126	5	protected function setInline(): void
127		{
128	5	$this->contentDisposition = self::DISPOSITION_INLINE;
129	5	$this->setDispositionHeader();
130	5	}
131	18	final protected function setAttachment(?string $fileName): void
132		{
133	18	$this->contentDisposition = self::DISPOSITION_ATTACHMENT;
134	18	$this->fileName = $fileName;
135	18	$this->setDispositionHeader();
136	18	}
137	21	final protected function setDispositionHeader(): void
138		{
139	21	$headerBody = ($this->contentDisposition === self::DISPOSITION_ATTACHMENT && $this->fileName !== null)
140	14	? sprintf(
141	14	'%s; filename="%s"; filename*=UTF-8\'\'%s',
142	14	$this->contentDisposition,
143	14	preg_replace('/[\x00-\x1F\x7F\"]/', ' ', $this->fileName),
144	14	rawurlencode($this->fileName)
145		)
146	21	: $this->contentDisposition;
147	21	$this->setHeader(Header::CONTENT_DISPOSITION, $headerBody);
148	21	}
149	1	private function fileContentType(string $filePath): ?string
150		{
151	1	if (!is_file($filePath) \|\| !is_readable($filePath)) {
152		return null;
153		}
154	1	if (function_exists('finfo_open')) {
155	1	$finfo = finfo_open(FILEINFO_MIME_TYPE);
156	1	$result = finfo_file($finfo, $filePath);
157	1	if (is_string($result)) {
158	1	return $result;
159		}
160		}
161		$result = $result ?? (function_exists('mime_content_type') ? mime_content_type($filePath) : null);
162		return is_string($result) ? $result : null;
163		}
164	2	private function bufferContentType(string $buffer): ?string
165		{
166	2	if (function_exists('finfo_open')) {
167	2	$finfo = finfo_open(FILEINFO_MIME_TYPE);
168	2	$result = finfo_buffer($finfo, $buffer);
169	2	if (is_string($result)) {
		0 ignored issues – show introduced 2020-08-03 15:41 UTC by Report Bug Copy Issue Report The condition `is_string($result)` is always `true`. Loading history...
170	2	return $result;
171		}
172		}
173		return null;
174		}
175		}
176

roxblnfk / smart-stream

Push — master ( 51d800...1482cb )

FileBucket::bufferContentType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like