GenericConsumer::addSpaceToRetParts() - Code Metrics - Inspection of "Refactor/cleanup for scrutinizer" - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 702f4a...a4fb40 )

by Zaahid

created 2016-02-29 04:43 UTC

GenericConsumer::addSpaceToRetParts() A

↳ Parent: GenericConsumer

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	2
eloc	6
nc	2
nop	4

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

use ZBateson\MailMimeParser\Header\Part\HeaderPart;
use ZBateson\MailMimeParser\Header\Part\Token;

/**
 * A minimal implementation of AbstractConsumer defining a CommentConsumer and
 * QuotedStringConsumer as sub-consumers, and splitting tokens by whitespace.
 *
 * Note that GenericConsumer should be instantiated with a
 * MimeLiteralPartFactory instead of a HeaderPartFactory.  Sub-classes may not
 * need MimeLiteralPartFactory instances though.
 * 
 * @author Zaahid Bateson
 */
class GenericConsumer extends AbstractConsumer
{
    /**
     * Returns \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer and
     * \ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer as
     * sub-consumers.
     * 
     * @return AbstractConsumer[] the sub-consumers
     */
    protected function getSubConsumers()
    {
        return [
            $this->consumerService->getCommentConsumer(),
            $this->consumerService->getQuotedStringConsumer(),
        ];
    }
    
    /**
     * Returns the regex '\s+' (whitespace) pattern matcher as a token marker so
     * the header value is split along whitespace characters.  GenericConsumer
     * filters out whitespace-only tokens from getPartForToken.
     * 
     * The whitespace character delimits mime-encoded parts for decoding.
     * 
     * @return string[] an array of regex pattern matchers
     */
    protected function getTokenSeparators()
    {
        return ['\s+'];
    }
    
    /**
     * GenericConsumer doesn't have start/end tokens, and so always returns
     * false.
     * 
     * @param string $token
     * @return boolean false
     */
    protected function isEndToken($token)
    {
        return false;
    }
    
    /**
     * GenericConsumer doesn't have start/end tokens, and so always returns
     * false.
     * 
     * @param string $token
     * @return boolean false
     */
    protected function isStartToken($token)
    {
        return false;
    }
    
    /**
     * Returns true if a space should be added based on the passed last and next
     * parts.
     * 
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $lastPart
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $nextPart
     * @return bool
     */
    private function shouldAddSpace(HeaderPart $nextPart, HeaderPart $lastPart = null)
    {
        return ($lastPart !== null && (!$lastPart->ignoreSpacesAfter() || !$nextPart->ignoreSpacesBefore()));
    }
    
    /**
     * Adds the passed $spacePart to the $retParts array if it should be added.
     * 
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $spacePart
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $retParts
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $nextPart
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $lastPart
     * @return bool
     */
    private function addSpaceToRetParts(HeaderPart &$spacePart, array &$retParts, HeaderPart $nextPart, HeaderPart $lastPart = null)
    {
        if ($this->shouldAddSpace($nextPart, $lastPart)) {
            $retParts[] = $spacePart;
            $spacePart = null;
            return true;
        }
        return false;
    }
    
    /**
     * Checks if the passed space part should be added to the returned parts and
     * adds it.
     * 
     * Never adds a space if it's the first part, otherwise only add it if
     * either part isn't set to ignore the space
     * 
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $retParts
     * @param int $curIndex
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $spacePart
     */
    private function addSpaces(array $parts, array &$retParts, $curIndex, HeaderPart &$spacePart = null)
    {
        if ($spacePart === null || $parts[$curIndex]->getValue() === '') {
            return;
        }
        $lastPart = end($retParts);
        $count = count($parts);
        for ($j = $curIndex; $j < $count; ++$j) {
            $nextPart = $parts[$j];
            if ($this->addSpaceToRetParts($spacePart, $retParts, $nextPart, $lastPart)) {
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
                break;
            }
        }
    }
    
    /**
     * Returns true if the passed HeaderPart is a Token instance and a space.
     * 
     * @param HeaderPart $part
     * @return bool
     */
    private function isSpaceToken(HeaderPart $part)
    {
        return ($part instanceof Token && $part->isSpace());
    }
    
    /**
     * Filters out ignorable spaces between parts in the passed array.
     * 
     * Spaces with parts on either side of it that specify they can be ignored
     * are filtered out.  filterIgnoredSpaces is called from within
     * processParts, and if needed by an implementing class that overrides
     * processParts, must be specifically called.
     * 
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
     * @return \ZBateson\MailMimeParser\Header\Part\HeaderPart[]
     */
    protected function filterIgnoredSpaces(array $parts)
    {
        $retParts = [];
        $spacePart = null;
        $count = count($parts);
        for ($i = 0; $i < $count; ++$i) {
            $part = $parts[$i];
            if ($this->isSpaceToken($part)) {
                $spacePart = $part;
                continue;
            }
            $this->addSpaces($parts, $retParts, $i, $spacePart);
            $retParts[] = $part;
        }
        // ignore trailing spaces
        return $retParts;
    }
    
    /**
     * Overridden to combine all part values into a single string and return it
     * as an array with a single element.
     * 
     * @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
     * @return \ZBateson\MailMimeParser\Header\Part\LiteralPart[]|array
     */
    protected function processParts(array $parts)
    {
        $strValue = '';
        $filtered = $this->filterIgnoredSpaces($parts);
        foreach ($filtered as $part) {
            $strValue .= $part->getValue();
        }
        return [$this->partFactory->newLiteralPart($strValue)];
    }
}


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			namespace ZBateson\MailMimeParser\Header\Consumer;
8
9			use ZBateson\MailMimeParser\Header\Part\HeaderPart;
10			use ZBateson\MailMimeParser\Header\Part\Token;
11
12			/**
13			* A minimal implementation of AbstractConsumer defining a CommentConsumer and
14			* QuotedStringConsumer as sub-consumers, and splitting tokens by whitespace.
15			*
16			* Note that GenericConsumer should be instantiated with a
17			* MimeLiteralPartFactory instead of a HeaderPartFactory. Sub-classes may not
18			* need MimeLiteralPartFactory instances though.
19			*
20			* @author Zaahid Bateson
21			*/
22			class GenericConsumer extends AbstractConsumer
23			{
24			/**
25			* Returns \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer and
26			* \ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer as
27			* sub-consumers.
28			*
29			* @return AbstractConsumer[] the sub-consumers
30			*/
31			protected function getSubConsumers()
32			{
33			return [
34			$this->consumerService->getCommentConsumer(),
35			$this->consumerService->getQuotedStringConsumer(),
36			];
37			}
38
39			/**
40			* Returns the regex '\s+' (whitespace) pattern matcher as a token marker so
41			* the header value is split along whitespace characters. GenericConsumer
42			* filters out whitespace-only tokens from getPartForToken.
43			*
44			* The whitespace character delimits mime-encoded parts for decoding.
45			*
46			* @return string[] an array of regex pattern matchers
47			*/
48			protected function getTokenSeparators()
49			{
50			return ['\s+'];
51			}
52
53			/**
54			* GenericConsumer doesn't have start/end tokens, and so always returns
55			* false.
56			*
57			* @param string $token
58			* @return boolean false
59			*/
60			protected function isEndToken($token)
61			{
62			return false;
63			}
64
65			/**
66			* GenericConsumer doesn't have start/end tokens, and so always returns
67			* false.
68			*
69			* @param string $token
70			* @return boolean false
71			*/
72			protected function isStartToken($token)
73			{
74			return false;
75			}
76
77			/**
78			* Returns true if a space should be added based on the passed last and next
79			* parts.
80			*
81			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $lastPart
82			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $nextPart
83			* @return bool
84			*/
85			private function shouldAddSpace(HeaderPart $nextPart, HeaderPart $lastPart = null)
86			{
87			return ($lastPart !== null && (!$lastPart->ignoreSpacesAfter() \|\| !$nextPart->ignoreSpacesBefore()));
88			}
89
90			/**
91			* Adds the passed $spacePart to the $retParts array if it should be added.
92			*
93			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $spacePart
94			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $retParts
95			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $nextPart
96			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $lastPart
97			* @return bool
98			*/
99			private function addSpaceToRetParts(HeaderPart &$spacePart, array &$retParts, HeaderPart $nextPart, HeaderPart $lastPart = null)
100			{
101			if ($this->shouldAddSpace($nextPart, $lastPart)) {
102			$retParts[] = $spacePart;
103			$spacePart = null;
104			return true;
105			}
106			return false;
107			}
108
109			/**
110			* Checks if the passed space part should be added to the returned parts and
111			* adds it.
112			*
113			* Never adds a space if it's the first part, otherwise only add it if
114			* either part isn't set to ignore the space
115			*
116			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
117			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $retParts
118			* @param int $curIndex
119			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart $spacePart
120			*/
121			private function addSpaces(array $parts, array &$retParts, $curIndex, HeaderPart &$spacePart = null)
122			{
123			if ($spacePart === null \|\| $parts[$curIndex]->getValue() === '') {
124			return;
125			}
126			$lastPart = end($retParts);
127			$count = count($parts);
128			for ($j = $curIndex; $j < $count; ++$j) {
129			$nextPart = $parts[$j];
130			if ($this->addSpaceToRetParts($spacePart, $retParts, $nextPart, $lastPart)) {
			0 ignored issues – show Security Bug introduced 2016-02-29 04:45 UTC by Report Bug Copy Issue Report It seems like `$lastPart` defined by `end($retParts)` on line `126` can also be of type `false`; however, `ZBateson\MailMimeParser\...r::addSpaceToRetParts()` does only seem to accept `null\|object<ZBateson\Mai...Header\Part\HeaderPart>`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
131			break;
132			}
133			}
134			}
135
136			/**
137			* Returns true if the passed HeaderPart is a Token instance and a space.
138			*
139			* @param HeaderPart $part
140			* @return bool
141			*/
142			private function isSpaceToken(HeaderPart $part)
143			{
144			return ($part instanceof Token && $part->isSpace());
145			}
146
147			/**
148			* Filters out ignorable spaces between parts in the passed array.
149			*
150			* Spaces with parts on either side of it that specify they can be ignored
151			* are filtered out. filterIgnoredSpaces is called from within
152			* processParts, and if needed by an implementing class that overrides
153			* processParts, must be specifically called.
154			*
155			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
156			* @return \ZBateson\MailMimeParser\Header\Part\HeaderPart[]
157			*/
158			protected function filterIgnoredSpaces(array $parts)
159			{
160			$retParts = [];
161			$spacePart = null;
162			$count = count($parts);
163			for ($i = 0; $i < $count; ++$i) {
164			$part = $parts[$i];
165			if ($this->isSpaceToken($part)) {
166			$spacePart = $part;
167			continue;
168			}
169			$this->addSpaces($parts, $retParts, $i, $spacePart);
170			$retParts[] = $part;
171			}
172			// ignore trailing spaces
173			return $retParts;
174			}
175
176			/**
177			* Overridden to combine all part values into a single string and return it
178			* as an array with a single element.
179			*
180			* @param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
181			* @return \ZBateson\MailMimeParser\Header\Part\LiteralPart[]\|array
182			*/
183			protected function processParts(array $parts)
184			{
185			$strValue = '';
186			$filtered = $this->filterIgnoredSpaces($parts);
187			foreach ($filtered as $part) {
188			$strValue .= $part->getValue();
189			}
190			return [$this->partFactory->newLiteralPart($strValue)];
191			}
192			}
193

zbateson / mail-mime-parser

Push — master ( 702f4a...a4fb40 )

GenericConsumer::addSpaceToRetParts() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like