HeaderPartFactory::newReceivedDomainPart() - Code Metrics - Inspection of "Fix tests" - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( e258e4...a626ba )

by Zaahid

created 2024-04-15 08:15 UTC

HeaderPartFactory::newReceivedDomainPart() A

↳ Parent: HeaderPartFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * This file is part of the ZBateson\MailMimeParser project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */

namespace ZBateson\MailMimeParser\Header\Part;

use Psr\Log\LoggerInterface;
use ZBateson\MailMimeParser\Header\IHeaderPart;
use ZBateson\MbWrapper\MbWrapper;

/**
 * Constructs and returns IHeaderPart objects.
 *
 * @author Zaahid Bateson
 */
class HeaderPartFactory
{
    /**
     * @var MbWrapper $charsetConverter passed to IHeaderPart constructors
     *      for converting strings in IHeaderPart::convertEncoding
     */
    protected MbWrapper $charsetConverter;

    protected LoggerInterface $logger;

    public function __construct(LoggerInterface $logger, MbWrapper $charsetConverter)
    {
        $this->logger = $logger;
        $this->charsetConverter = $charsetConverter;
    }

    /**
     * Creates and returns a default IHeaderPart for this factory, allowing
     * subclass factories for specialized IHeaderParts.
     *
     * The default implementation returns a new Token
     */
    public function newInstance(string $value) : IHeaderPart
    {
        return $this->newToken($value);
    }

    /**
     * Initializes and returns a new Token.
     */
    public function newToken(string $value, bool $isLiteral = false, bool $preserveSpaces = false) : Token
    {
        return new Token($this->logger, $this->charsetConverter, $value, $isLiteral, $preserveSpaces);
    }

    /**
     * Initializes and returns a new SubjectToken.
     */
    public function newSubjectToken(string $value) : SubjectToken
    {
        return new SubjectToken($this->logger, $this->charsetConverter, $value);
    }

    /**
     * Initializes and returns a new MimeToken.
     */
    public function newMimeToken(string $value) : MimeToken
    {
        return new MimeToken($this->logger, $this->charsetConverter, $value);
    }

    /**
     * Initializes and returns a new ContainerPart.
     *
     * @param HeaderPart[] $children
     */
    public function newContainerPart(array $children) : ContainerPart
    {
        return new ContainerPart($this->logger, $this->charsetConverter, $children);
    }

    /**
     * Instantiates and returns a SplitParameterPart.
     *
     * @param ParameterPart[] $children
     */
    public function newSplitParameterPart(array $children) : SplitParameterPart
    {
        return new SplitParameterPart($this->logger, $this->charsetConverter, $this, $children);
    }

    /**
     * Initializes and returns a new QuotedLiteralPart.
     *
     * @param HeaderPart[] $children
     */
    public function newQuotedLiteralPart(array $parts) : QuotedLiteralPart
    {
        return new QuotedLiteralPart($this->logger, $this->charsetConverter, $parts);
    }

    /**
     * Initializes and returns a new CommentPart.
     *
     * @param HeaderPart[] $children
     */
    public function newCommentPart(array $children) : CommentPart
    {
        return new CommentPart($this->logger, $this->charsetConverter, $this, $children);
    }

    /**
     * Initializes and returns a new AddressPart.
     *
     * @param HeaderPart[] $nameParts
     * @param HeaderPart[] $emailParts
     */
    public function newAddress(array $nameParts, array $emailParts) : AddressPart
    {
        return new AddressPart($this->logger, $this->charsetConverter, $nameParts, $emailParts);
    }

    /**
     * Initializes and returns a new AddressGroupPart
     *
     * @param HeaderPart[] $nameParts
     * @param AddressPart[]|AddressGroupPart[] $addressesAndGroups
     */
    public function newAddressGroupPart(array $nameParts, array $addressesAndGroups) : AddressGroupPart
    {
        return new AddressGroupPart($this->logger, $this->charsetConverter, $nameParts, $addressesAndGroups);
    }

    /**
     * Initializes and returns a new DatePart
     *
     * @param HeaderPart[] $children
     */
    public function newDatePart(array $children) : DatePart
    {
        return new DatePart($this->logger, $this->charsetConverter, $children);
    }

    /**
     * Initializes and returns a new ParameterPart.
     *
     * @param HeaderPart[] $nameParts
     */
    public function newParameterPart(array $nameParts, ContainerPart $valuePart) : ParameterPart
    {
        return new ParameterPart($this->logger, $this->charsetConverter, $nameParts, $valuePart);
    }

    /**
     * Initializes and returns a new ReceivedPart.
     *
     * @param HeaderPart[] $children
     */
    public function newReceivedPart(string $name, array $children) : ReceivedPart
    {
        return new ReceivedPart($this->logger, $this->charsetConverter, $name, $children);
    }

    /**
     * Initializes and returns a new ReceivedDomainPart.
     *
     * @param HeaderPart[] $children
     */
    public function newReceivedDomainPart(string $name, array $children) : ReceivedDomainPart
    {
        return new ReceivedDomainPart(
            $this->logger,
            $this->charsetConverter,
            $name,
            $children
        );
    }
}


1		<?php
2		/**
3		* This file is part of the ZBateson\MailMimeParser project.
4		*
5		* @license http://opensource.org/licenses/bsd-license.php BSD
6		*/
7
8		namespace ZBateson\MailMimeParser\Header\Part;
9
10		use Psr\Log\LoggerInterface;
11		use ZBateson\MailMimeParser\Header\IHeaderPart;
12		use ZBateson\MbWrapper\MbWrapper;
13
14		/**
15		* Constructs and returns IHeaderPart objects.
16		*
17		* @author Zaahid Bateson
18		*/
19		class HeaderPartFactory
20		{
21		/**
22		* @var MbWrapper $charsetConverter passed to IHeaderPart constructors
23		* for converting strings in IHeaderPart::convertEncoding
24		*/
25		protected MbWrapper $charsetConverter;
26
27		protected LoggerInterface $logger;
28
29		public function __construct(LoggerInterface $logger, MbWrapper $charsetConverter)
30	12	{
31		$this->logger = $logger;
32	12	$this->charsetConverter = $charsetConverter;
33		}
34
35		/**
36		* Creates and returns a default IHeaderPart for this factory, allowing
37		* subclass factories for specialized IHeaderParts.
38		*
39		* The default implementation returns a new Token
40		*/
41	96	public function newInstance(string $value) : IHeaderPart
42		{
43	96	return $this->newToken($value);
44		}
45
46		/**
47		* Initializes and returns a new Token.
48		*/
49	107	public function newToken(string $value, bool $isLiteral = false, bool $preserveSpaces = false) : Token
50		{
51	107	return new Token($this->logger, $this->charsetConverter, $value, $isLiteral, $preserveSpaces);
52		}
53
54		/**
55		* Initializes and returns a new SubjectToken.
56		*/
57	2	public function newSubjectToken(string $value) : SubjectToken
58		{
59	2	return new SubjectToken($this->logger, $this->charsetConverter, $value);
60		}
61
62		/**
63		* Initializes and returns a new MimeToken.
64		*/
65	106	public function newMimeToken(string $value) : MimeToken
66		{
67	106	return new MimeToken($this->logger, $this->charsetConverter, $value);
68		}
69
70		/**
71		* Initializes and returns a new ContainerPart.
72		*
73	106	* @param HeaderPart[] $children
74		*/
75	106	public function newContainerPart(array $children) : ContainerPart
76		{
77		return new ContainerPart($this->logger, $this->charsetConverter, $children);
78		}
79
80		/**
81	16	* Instantiates and returns a SplitParameterPart.
82		*
83	16	* @param ParameterPart[] $children
84		*/
85		public function newSplitParameterPart(array $children) : SplitParameterPart
86		{
87		return new SplitParameterPart($this->logger, $this->charsetConverter, $this, $children);
88		}
89	96
90		/**
91	96	* Initializes and returns a new QuotedLiteralPart.
92		*
93		* @param HeaderPart[] $children
94		*/
95		public function newQuotedLiteralPart(array $parts) : QuotedLiteralPart
96		{
97		return new QuotedLiteralPart($this->logger, $this->charsetConverter, $parts);
98		}
99	1
100		/**
101	1	* Initializes and returns a new CommentPart.
102		*
103		* @param HeaderPart[] $children
104		*/
105		public function newCommentPart(array $children) : CommentPart
106		{
107	20	return new CommentPart($this->logger, $this->charsetConverter, $this, $children);
108		}
109	20
110		/**
111		* Initializes and returns a new AddressPart.
112		*
113		* @param HeaderPart[] $nameParts
114		* @param HeaderPart[] $emailParts
115	101	*/
116		public function newAddress(array $nameParts, array $emailParts) : AddressPart
117	101	{
118		return new AddressPart($this->logger, $this->charsetConverter, $nameParts, $emailParts);
119		}
120
121		/**
122		* Initializes and returns a new AddressGroupPart
123	1	*
124		* @param HeaderPart[] $nameParts
125	1	* @param AddressPart[]\|AddressGroupPart[] $addressesAndGroups
126		*/
127		public function newAddressGroupPart(array $nameParts, array $addressesAndGroups) : AddressGroupPart
128		{
129		return new AddressGroupPart($this->logger, $this->charsetConverter, $nameParts, $addressesAndGroups);
130		}
131	1
132		/**
133		* Initializes and returns a new DatePart
134		*
135		* @param HeaderPart[] $children
136		*/
137		public function newDatePart(array $children) : DatePart
138	1	{
139	1	return new DatePart($this->logger, $this->charsetConverter, $children);
140	1	}
141	1
142	1	/**
143	1	* Initializes and returns a new ParameterPart.
144	1	*
145	1	* @param HeaderPart[] $nameParts
146		*/
147		public function newParameterPart(array $nameParts, ContainerPart $valuePart) : ParameterPart
148		{
149		return new ParameterPart($this->logger, $this->charsetConverter, $nameParts, $valuePart);
150		}
151
152		/**
153		* Initializes and returns a new ReceivedPart.
154		*
155		* @param HeaderPart[] $children
156		*/
157		public function newReceivedPart(string $name, array $children) : ReceivedPart
158		{
159		return new ReceivedPart($this->logger, $this->charsetConverter, $name, $children);
160		}
161
162		/**
163		* Initializes and returns a new ReceivedDomainPart.
164		*
165		* @param HeaderPart[] $children
166		*/
167		public function newReceivedDomainPart(string $name, array $children) : ReceivedDomainPart
168		{
169		return new ReceivedDomainPart(
170		$this->logger,
171		$this->charsetConverter,
172		$name,
173		$children
174		);
175		}
176		}
177

zbateson / mail-mime-parser

Push — master ( e258e4...a626ba )

HeaderPartFactory::newReceivedDomainPart() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like