MultiPart::removePart() - Code Metrics - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

MultiPart::removePart() A
last analyzed 2025-09-03 23:45 UTC

↳ Parent: MultiPart

Complexity

Conditions	4
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

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

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

namespace ZBateson\MailMimeParser\Message;

use AppendIterator;
use ArrayIterator;
use Iterator;
use Psr\Log\LoggerInterface;
use RecursiveIterator;
use RecursiveIteratorIterator;

/**
 * A message part that contains children.
 *
 * @author Zaahid Bateson
 */
abstract class MultiPart extends MessagePart implements IMultiPart
{
    /**
     * @var PartChildrenContainer child part container
     */
    protected PartChildrenContainer $partChildrenContainer;

    public function __construct(
        LoggerInterface $logger,
        PartStreamContainer $streamContainer,
        PartChildrenContainer $partChildrenContainer,
        ?IMimePart $parent = null
    ) {
        parent::__construct($logger, $streamContainer, $parent);
        $this->partChildrenContainer = $partChildrenContainer;
    }

    private function getAllPartsIterator() : AppendIterator
    {
        $iter = new AppendIterator();
        $iter->append(new ArrayIterator([$this]));
        $iter->append(new RecursiveIteratorIterator($this->partChildrenContainer, RecursiveIteratorIterator::SELF_FIRST));
        return $iter;
    }

    private function iteratorFindAt(Iterator $iter, int $index, ?callable $fnFilter = null) : ?IMessagePart
    {
        $pos = 0;
        foreach ($iter as $part) {
            if (($fnFilter === null || $fnFilter($part))) {
                if ($index === $pos) {
                    return $part;
                }
                ++$pos;
            }
        }
        return null;
    }

    public function getPart(int $index, ?callable $fnFilter = null) : ?IMessagePart
    {
        return $this->iteratorFindAt(
            $this->getAllPartsIterator(),
            $index,
            $fnFilter
        );
    }

    public function getAllParts(?callable $fnFilter = null) : array
    {
        $array = \iterator_to_array($this->getAllPartsIterator(), false);
        if ($fnFilter !== null) {
            return \array_values(\array_filter($array, $fnFilter));
        }
        return $array;
    }

    public function getPartCount(?callable $fnFilter = null) : int
    {
        return \count($this->getAllParts($fnFilter));
    }

    public function getChild(int $index, ?callable $fnFilter = null) : ?IMessagePart
    {
        return $this->iteratorFindAt(
            $this->partChildrenContainer,
            $index,
            $fnFilter
        );
    }

    public function getChildIterator() : RecursiveIterator
    {
        return $this->partChildrenContainer;
    }

    public function getChildParts(?callable $fnFilter = null) : array
    {
        $array = \iterator_to_array($this->partChildrenContainer, false);
        if ($fnFilter !== null) {
            return \array_values(\array_filter($array, $fnFilter));
        }
        return $array;
    }

    public function getChildCount(?callable $fnFilter = null) : int
    {
        return \count($this->getChildParts($fnFilter));
    }

    public function getPartByMimeType(string $mimeType, int $index = 0) : ?IMessagePart
    {
        return $this->getPart($index, PartFilter::fromContentType($mimeType));
    }

    public function getAllPartsByMimeType(string $mimeType) : array
    {
        return $this->getAllParts(PartFilter::fromContentType($mimeType));
    }

    public function getCountOfPartsByMimeType(string $mimeType) : int
    {
        return $this->getPartCount(PartFilter::fromContentType($mimeType));
    }

    public function getPartByContentId(string $contentId) : ?IMessagePart
    {
        $sanitized = \preg_replace('/^\s*<|>\s*$/', '', $contentId);
        return $this->getPart(0, function(IMessagePart $part) use ($sanitized) {

            $cid = $part->getContentId();
            return ($cid !== null && \strcasecmp($cid, $sanitized) === 0);
        });
    }

    public function addChild(MessagePart $part, ?int $position = null) : static
    {
        if ($part !== $this) {

            $part->parent = $this;

            $this->partChildrenContainer->add($part, $position);
            $this->notify();
        }
        return $this;
    }

    public function removePart(IMessagePart $part) : ?int
    {
        $parent = $part->getParent();
        if ($this !== $parent && $parent !== null) {
            return $parent->removePart($part);
        }

        $position = $this->partChildrenContainer->remove($part);
        if ($position !== null) {
            $this->notify();
        }
        return $position;
    }

    public function removeAllParts(?callable $fnFilter = null) : int
    {
        $parts = $this->getAllParts($fnFilter);
        $count = \count($parts);
        foreach ($parts as $part) {
            if ($part === $this) {
                --$count;
                continue;
            }
            $this->removePart($part);
        }
        return $count;
    }

    protected function getErrorBagChildren() : array
    {
        return \array_merge(parent::getErrorBagChildren(), $this->getChildParts());
    }
}


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\Message;
9
10		use AppendIterator;
11		use ArrayIterator;
12		use Iterator;
13		use Psr\Log\LoggerInterface;
14		use RecursiveIterator;
15		use RecursiveIteratorIterator;
16
17		/**
18		* A message part that contains children.
19		*
20		* @author Zaahid Bateson
21		*/
22		abstract class MultiPart extends MessagePart implements IMultiPart
23		{
24		/**
25		* @var PartChildrenContainer child part container
26		*/
27		protected PartChildrenContainer $partChildrenContainer;
28
29	141	public function __construct(
30		LoggerInterface $logger,
31		PartStreamContainer $streamContainer,
32		PartChildrenContainer $partChildrenContainer,
33		?IMimePart $parent = null
34		) {
35	141	parent::__construct($logger, $streamContainer, $parent);
36	141	$this->partChildrenContainer = $partChildrenContainer;
37		}
38
39	111	private function getAllPartsIterator() : AppendIterator
40		{
41	111	$iter = new AppendIterator();
42	111	$iter->append(new ArrayIterator([$this]));
43	111	$iter->append(new RecursiveIteratorIterator($this->partChildrenContainer, RecursiveIteratorIterator::SELF_FIRST));
44	111	return $iter;
45		}
46
47	101	private function iteratorFindAt(Iterator $iter, int $index, ?callable $fnFilter = null) : ?IMessagePart
48		{
49	101	$pos = 0;
50	101	foreach ($iter as $part) {
51	101	if (($fnFilter === null \|\| $fnFilter($part))) {
52	101	if ($index === $pos) {
53	101	return $part;
54		}
55	26	++$pos;
56		}
57		}
58	18	return null;
59		}
60
61	90	public function getPart(int $index, ?callable $fnFilter = null) : ?IMessagePart
62		{
63	90	return $this->iteratorFindAt(
64	90	$this->getAllPartsIterator(),
65	90	$index,
66	90	$fnFilter
67	90	);
68		}
69
70	103	public function getAllParts(?callable $fnFilter = null) : array
71		{
72	103	$array = \iterator_to_array($this->getAllPartsIterator(), false);
73	103	if ($fnFilter !== null) {
74	64	return \array_values(\array_filter($array, $fnFilter));
75		}
76	79	return $array;
77		}
78
79	4	public function getPartCount(?callable $fnFilter = null) : int
80		{
81	4	return \count($this->getAllParts($fnFilter));
82		}
83
84	25	public function getChild(int $index, ?callable $fnFilter = null) : ?IMessagePart
85		{
86	25	return $this->iteratorFindAt(
87	25	$this->partChildrenContainer,
88	25	$index,
89	25	$fnFilter
90	25	);
91		}
92
93	80	public function getChildIterator() : RecursiveIterator
94		{
95	80	return $this->partChildrenContainer;
96		}
97
98	103	public function getChildParts(?callable $fnFilter = null) : array
99		{
100	103	$array = \iterator_to_array($this->partChildrenContainer, false);
101	103	if ($fnFilter !== null) {
102	3	return \array_values(\array_filter($array, $fnFilter));
103		}
104	102	return $array;
105		}
106
107	99	public function getChildCount(?callable $fnFilter = null) : int
108		{
109	99	return \count($this->getChildParts($fnFilter));
110		}
111
112	2	public function getPartByMimeType(string $mimeType, int $index = 0) : ?IMessagePart
113		{
114	2	return $this->getPart($index, PartFilter::fromContentType($mimeType));
115		}
116
117	1	public function getAllPartsByMimeType(string $mimeType) : array
118		{
119	1	return $this->getAllParts(PartFilter::fromContentType($mimeType));
120		}
121
122	1	public function getCountOfPartsByMimeType(string $mimeType) : int
123		{
124	1	return $this->getPartCount(PartFilter::fromContentType($mimeType));
125		}
126
127	2	public function getPartByContentId(string $contentId) : ?IMessagePart
128		{
129	2	$sanitized = \preg_replace('/^\s<\|>\s$/', '', $contentId);
130	2	return $this->getPart(0, function(IMessagePart $part) use ($sanitized) {
		0 ignored issues – show Coding Style introduced 2023-01-13 23:13 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
131	2	$cid = $part->getContentId();
132	2	return ($cid !== null && \strcasecmp($cid, $sanitized) === 0);
133	2	});
134		}
135
136	23	public function addChild(MessagePart $part, ?int $position = null) : static
137		{
138	23	if ($part !== $this) {
		0 ignored issues – show introduced 2018-12-20 23:56 UTC by Report Bug Copy Issue Report The condition `$part !== $this` is always `true`. Loading history...
139	23	$part->parent = $this;
		0 ignored issues – show Documentation Bug introduced 2024-03-18 06:31 UTC by Report Bug Copy Issue Report It seems like `$this` of type `ZBateson\MailMimeParser\Message\MultiPart` is incompatible with the declared type `ZBateson\MailMimeParser\Message\IMimePart\|null` of property `$parent`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
140	23	$this->partChildrenContainer->add($part, $position);
141	23	$this->notify();
142		}
143	23	return $this;
144		}
145
146	20	public function removePart(IMessagePart $part) : ?int
147		{
148	20	$parent = $part->getParent();
149	20	if ($this !== $parent && $parent !== null) {
150	6	return $parent->removePart($part);
151		}
152
153	20	$position = $this->partChildrenContainer->remove($part);
154	20	if ($position !== null) {
155	20	$this->notify();
156		}
157	20	return $position;
158		}
159
160	3	public function removeAllParts(?callable $fnFilter = null) : int
161		{
162	3	$parts = $this->getAllParts($fnFilter);
163	3	$count = \count($parts);
164	3	foreach ($parts as $part) {
165	3	if ($part === $this) {
166	2	--$count;
167	2	continue;
168		}
169	3	$this->removePart($part);
170		}
171	3	return $count;
172		}
173
174	1	protected function getErrorBagChildren() : array
175		{
176	1	return \array_merge(parent::getErrorBagChildren(), $this->getChildParts());
177		}
178		}
179

zbateson / mail-mime-parser

MultiPart::removePart() A last analyzed 2025-09-03 23:45 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

MultiPart::removePart() A
last analyzed 2025-09-03 23:45 UTC