File::content() - Code Metrics - yiisoft/mailer - Measure and Improve Code Quality continuously with Scrutinizer

File::content() A
last analyzed 2024-05-19 14:30 UTC

↳ Parent: File

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Mailer;

use Exception;
use RuntimeException;

use function bin2hex;
use function is_file;
use function random_bytes;

/**
 * `File` is a data object that stores data for attaching a file to a mail message.
 */
final class File
{
    /**
     * @var string|null The file ID.
     */
    private ?string $id = null;

    /**
     * @param string|null $name The name that should be used to attach the file.
     * @param string|null $path The full path to the file.
     * @param string|null $content The content that should be used to attach the file.
     * @param string|null $contentType MIME type that should be used to attach the file.
     */
    private function __construct(
        private ?string $name,
        private ?string $path,
        private ?string $content,
        private ?string $contentType
    ) {
    }

    /**
     * Creates a new file instance from the specified content.
     *
     * @param string $content The content that should be used to attach the file.
     * @param string|null $name The name that should be used to attach the file.
     * @param string|null $contentType MIME type that should be used to attach the file.
     */
    public static function fromContent(string $content, string $name = null, string $contentType = null): self
    {
        return new self($name, null, $content, $contentType);
    }

    /**
     * Creates a new file instance from the specified full path to the file.
     *
     * @param string $path The full path to the file.
     * @param string|null $name The name that should be used to attach the file.
     * @param string|null $contentType MIME type that should be used to attach the file.
     *
     * @throws RuntimeException If the specified file does not exist.
     */
    public static function fromPath(string $path, string $name = null, string $contentType = null): self
    {
        if (!is_file($path)) {
            throw new RuntimeException("The file {$path} does not exist.");
        }

        return new self($name, $path, null, $contentType);
    }

    /**
     * Returns the file ID.
     *
     * @throws Exception {@see https://www.php.net/manual/en/function.random-bytes.php}
     *
     * @return string The file ID.
     */
    public function id(): string
    {
        if ($this->id === null) {
            $this->id = bin2hex(random_bytes(16)) . '@app';
        }

        return $this->id;

    }

    /**
     * Returns the file CID source.
     *
     * @throws Exception {@see https://www.php.net/manual/en/function.random-bytes.php}
     *
     * @return string The file CID source.
     */
    public function cid(): string
    {
        return "cid:{$this->id()}";
    }

    /**
     * Returns the name that should be used to attach the file.
     *
     * @return string|null The name that should be used to attach the file.
     */
    public function name(): ?string
    {
        return $this->name;
    }

    /**
     * Returns the full path to the file.
     *
     * @return string|null The full path to the file.
     */
    public function path(): ?string
    {
        return $this->path;
    }

    /**
     * Returns the content that should be used to attach the file.
     *
     * @return string|null The content that should be used to attach the file.
     */
    public function content(): ?string
    {
        return $this->content;
    }

    /**
     * Returns the MIME type that should be used to attach the file.
     *
     * @return string|null MIME type that should be used to attach the file.
     */
    public function contentType(): ?string
    {
        return $this->contentType;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Mailer;
6
7		use Exception;
8		use RuntimeException;
9
10		use function bin2hex;
11		use function is_file;
12		use function random_bytes;
13
14		/**
15		* `File` is a data object that stores data for attaching a file to a mail message.
16		*/
17		final class File
18		{
19		/**
20		* @var string\|null The file ID.
21		*/
22		private ?string $id = null;
23
24		/**
25		* @param string\|null $name The name that should be used to attach the file.
26		* @param string\|null $path The full path to the file.
27		* @param string\|null $content The content that should be used to attach the file.
28		* @param string\|null $contentType MIME type that should be used to attach the file.
29		*/
30		private function __construct(
31		private ?string $name,
32		private ?string $path,
33		private ?string $content,
34		private ?string $contentType
35		) {
36		}
37
38		/**
39		* Creates a new file instance from the specified content.
40		*
41		* @param string $content The content that should be used to attach the file.
42		* @param string\|null $name The name that should be used to attach the file.
43		* @param string\|null $contentType MIME type that should be used to attach the file.
44		*/
45		public static function fromContent(string $content, string $name = null, string $contentType = null): self
46		{
47		return new self($name, null, $content, $contentType);
48		}
49
50	3	/**
51		* Creates a new file instance from the specified full path to the file.
52	3	*
53	3	* @param string $path The full path to the file.
54	3	* @param string\|null $name The name that should be used to attach the file.
55	3	* @param string\|null $contentType MIME type that should be used to attach the file.
56		*
57		* @throws RuntimeException If the specified file does not exist.
58		*/
59		public static function fromPath(string $path, string $name = null, string $contentType = null): self
60		{
61		if (!is_file($path)) {
62		throw new RuntimeException("The file {$path} does not exist.");
63		}
64
65		return new self($name, $path, null, $contentType);
66		}
67	1
68		/**
69	1	* Returns the file ID.
70		*
71		* @throws Exception {@see https://www.php.net/manual/en/function.random-bytes.php}
72		*
73		* @return string The file ID.
74		*/
75		public function id(): string
76		{
77		if ($this->id === null) {
78		$this->id = bin2hex(random_bytes(16)) . '@app';
79		}
80
81		return $this->id;
		0 ignored issues – show Bug Best Practice introduced 2021-01-28 22:31 UTC by Report Bug Copy Issue Report The expression `return $this->id` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
82		}
83	4
84		/**
85	4	* Returns the file CID source.
86	2	*
87		* @throws Exception {@see https://www.php.net/manual/en/function.random-bytes.php}
88		*
89	2	* @return string The file CID source.
90		*/
91		public function cid(): string
92		{
93		return "cid:{$this->id()}";
94		}
95
96		/**
97		* Returns the name that should be used to attach the file.
98		*
99	3	* @return string\|null The name that should be used to attach the file.
100		*/
101	3	public function name(): ?string
102	3	{
103		return $this->name;
104		}
105	3
106		/**
107		* Returns the full path to the file.
108		*
109		* @return string\|null The full path to the file.
110		*/
111		public function path(): ?string
112		{
113		return $this->path;
114		}
115	3
116		/**
117	3	* Returns the content that should be used to attach the file.
118		*
119		* @return string\|null The content that should be used to attach the file.
120		*/
121		public function content(): ?string
122		{
123		return $this->content;
124		}
125	2
126		/**
127	2	* Returns the MIME type that should be used to attach the file.
128		*
129		* @return string\|null MIME type that should be used to attach the file.
130		*/
131		public function contentType(): ?string
132		{
133		return $this->contentType;
134		}
135		}
136

yiisoft / mailer

File::content() A last analyzed 2024-05-19 14:30 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

File::content() A
last analyzed 2024-05-19 14:30 UTC