ConsumerService::getIdBaseConsumer() - Code Metrics - Inspection of "Remove 'allow_failures' for 8.0" - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2d7619...5b987a )

by Zaahid

created 2020-12-10 20:07 UTC

ConsumerService::getIdBaseConsumer() A

↳ Parent: ConsumerService

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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\HeaderPartFactory;
use ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory;
use ZBateson\MailMimeParser\Header\Consumer\Received\DomainConsumer;
use ZBateson\MailMimeParser\Header\Consumer\Received\GenericReceivedConsumer;
use ZBateson\MailMimeParser\Header\Consumer\Received\ReceivedDateConsumer;

/**
 * Simple service provider for consumer singletons.
 *
 * @author Zaahid Bateson
 */
class ConsumerService
{
    /**
     * @var \ZBateson\MailMimeParser\Header\Part\HeaderPartFactory the
     * HeaderPartFactory instance used to create HeaderParts.
     */
    protected $partFactory;
    
    /**
     * @var \ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory used for
     * GenericConsumer instances.
     */
    protected $mimeLiteralPartFactory;

    /**
     * @var Received\DomainConsumer[]|
     *      Received\GenericReceivedConsumer[]|
     *      Received\ReceivedDateConsumer[] an array of sub-received header
     *      consumer instances.
     */
    protected $receivedConsumers = [
        'from' => null,
        'by' => null,
        'via' => null,
        'with' => null,
        'id' => null,
        'for' => null,
        'date' => null
    ];
    
    /**
     * Sets up the HeaderPartFactory member variable.
     * 
     * @param HeaderPartFactory $partFactory
     * @param MimeLiteralPartFactory $mimeLiteralPartFactory
     */
    public function __construct(HeaderPartFactory $partFactory, MimeLiteralPartFactory $mimeLiteralPartFactory)
    {
        $this->partFactory = $partFactory;
        $this->mimeLiteralPartFactory = $mimeLiteralPartFactory;
    }
    
    /**
     * Returns the AddressBaseConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\AddressBaseConsumer
     */
    public function getAddressBaseConsumer()
    {
        return AddressBaseConsumer::getInstance($this, $this->partFactory);
    }
    
    /**
     * Returns the AddressConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\AddressConsumer
     */
    public function getAddressConsumer()
    {
        return AddressConsumer::getInstance($this, $this->partFactory);
    }
    
    /**
     * Returns the AddressGroupConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\AddressGroupConsumer
     */
    public function getAddressGroupConsumer()
    {
        return AddressGroupConsumer::getInstance($this, $this->partFactory);
    }
    
    /**
     * Returns the CommentConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer
     */
    public function getCommentConsumer()
    {
        return CommentConsumer::getInstance($this, $this->partFactory);
    }
    
    /**
     * Returns the GenericConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\GenericConsumer
     */
    public function getGenericConsumer()
    {
        return GenericConsumer::getInstance($this, $this->mimeLiteralPartFactory);
    }

    /**
     * Returns the SubjectConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\SubjectConsumer
     */
    public function getSubjectConsumer()
    {
        return SubjectConsumer::getInstance($this, $this->mimeLiteralPartFactory);
    }
    
    /**
     * Returns the QuotedStringConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer
     */
    public function getQuotedStringConsumer()
    {
        return QuotedStringConsumer::getInstance($this, $this->partFactory);
    }
    
    /**
     * Returns the DateConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\DateConsumer
     */
    public function getDateConsumer()
    {
        return DateConsumer::getInstance($this, $this->partFactory);
    }
    
    /**
     * Returns the ParameterConsumer singleton instance.
     * 
     * @return \ZBateson\MailMimeParser\Header\Consumer\ParameterConsumer
     */
    public function getParameterConsumer()
    {
        return ParameterConsumer::getInstance($this, $this->partFactory);
    }

    /**
     * Returns the consumer instance corresponding to the passed part name of a
     * Received header.
     *
     * @param string $partName
     * @return \ZBateson\MailMimeParser\Header\Consumer\Received\FromConsumer
filter:
    dependency_paths: ["lib/*"]
     */
    public function getSubReceivedConsumer($partName)
    {
        if (empty($this->receivedConsumers[$partName])) {
            $consumer = null;
            if ($partName === 'from' || $partName === 'by') {
                $consumer = new DomainConsumer($this, $this->partFactory, $partName);
            } else if ($partName === 'date') {
                $consumer = new ReceivedDateConsumer($this, $this->partFactory);
            } else {
                $consumer = new GenericReceivedConsumer($this, $this->partFactory, $partName);
            }
            $this->receivedConsumers[$partName] = $consumer;
        }
        return $this->receivedConsumers[$partName];
    }

    /**
     * Returns the ReceivedConsumer singleton instance.
     *
     * @return \ZBateson\MailMimeParser\Header\Consumer\ReceivedConsumer
     */
    public function getReceivedConsumer()
    {
        return ReceivedConsumer::getInstance($this, $this->partFactory);
    }

    /**
     * Returns the IdConsumer singleton instance.
     *
     * @return \ZBateson\MailMimeParser\Header\Consumer\IdConsumer
     */
    public function getIdConsumer()
    {
        return IdConsumer::getInstance($this, $this->partFactory);
    }

    /**
     * Returns the IdBaseConsumer singleton instance.
     *
     * @return \ZBateson\MailMimeParser\Header\Consumer\IdBaseConsumer
     */
    public function getIdBaseConsumer()
    {
        return IdBaseConsumer::getInstance($this, $this->partFactory);
    }
}


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\HeaderPartFactory;
10		use ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory;
11		use ZBateson\MailMimeParser\Header\Consumer\Received\DomainConsumer;
12		use ZBateson\MailMimeParser\Header\Consumer\Received\GenericReceivedConsumer;
13		use ZBateson\MailMimeParser\Header\Consumer\Received\ReceivedDateConsumer;
14
15		/**
16		* Simple service provider for consumer singletons.
17		*
18		* @author Zaahid Bateson
19		*/
20		class ConsumerService
21		{
22		/**
23		* @var \ZBateson\MailMimeParser\Header\Part\HeaderPartFactory the
24		* HeaderPartFactory instance used to create HeaderParts.
25		*/
26		protected $partFactory;
27
28		/**
29		* @var \ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory used for
30		* GenericConsumer instances.
31		*/
32		protected $mimeLiteralPartFactory;
33
34		/**
35		* @var Received\DomainConsumer[]\|
36		* Received\GenericReceivedConsumer[]\|
37		* Received\ReceivedDateConsumer[] an array of sub-received header
38		* consumer instances.
39		*/
40		protected $receivedConsumers = [
41		'from' => null,
42		'by' => null,
43		'via' => null,
44		'with' => null,
45		'id' => null,
46		'for' => null,
47		'date' => null
48		];
49
50		/**
51		* Sets up the HeaderPartFactory member variable.
52		*
53		* @param HeaderPartFactory $partFactory
54		* @param MimeLiteralPartFactory $mimeLiteralPartFactory
55		*/
56	112	public function __construct(HeaderPartFactory $partFactory, MimeLiteralPartFactory $mimeLiteralPartFactory)
57		{
58	112	$this->partFactory = $partFactory;
59	112	$this->mimeLiteralPartFactory = $mimeLiteralPartFactory;
60	112	}
61
62		/**
63		* Returns the AddressBaseConsumer singleton instance.
64		*
65		* @return \ZBateson\MailMimeParser\Header\Consumer\AddressBaseConsumer
66		*/
67	95	public function getAddressBaseConsumer()
68		{
69	95	return AddressBaseConsumer::getInstance($this, $this->partFactory);
70		}
71
72		/**
73		* Returns the AddressConsumer singleton instance.
74		*
75		* @return \ZBateson\MailMimeParser\Header\Consumer\AddressConsumer
76		*/
77	95	public function getAddressConsumer()
78		{
79	95	return AddressConsumer::getInstance($this, $this->partFactory);
80		}
81
82		/**
83		* Returns the AddressGroupConsumer singleton instance.
84		*
85		* @return \ZBateson\MailMimeParser\Header\Consumer\AddressGroupConsumer
86		*/
87	95	public function getAddressGroupConsumer()
88		{
89	95	return AddressGroupConsumer::getInstance($this, $this->partFactory);
90		}
91
92		/**
93		* Returns the CommentConsumer singleton instance.
94		*
95		* @return \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer
96		*/
97	105	public function getCommentConsumer()
98		{
99	105	return CommentConsumer::getInstance($this, $this->partFactory);
100		}
101
102		/**
103		* Returns the GenericConsumer singleton instance.
104		*
105		* @return \ZBateson\MailMimeParser\Header\Consumer\GenericConsumer
106		*/
107	98	public function getGenericConsumer()
108		{
109	98	return GenericConsumer::getInstance($this, $this->mimeLiteralPartFactory);
110		}
111
112		/**
113		* Returns the SubjectConsumer singleton instance.
114		*
115		* @return \ZBateson\MailMimeParser\Header\Consumer\SubjectConsumer
116		*/
117	94	public function getSubjectConsumer()
118		{
119	94	return SubjectConsumer::getInstance($this, $this->mimeLiteralPartFactory);
120		}
121
122		/**
123		* Returns the QuotedStringConsumer singleton instance.
124		*
125		* @return \ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer
126		*/
127	105	public function getQuotedStringConsumer()
128		{
129	105	return QuotedStringConsumer::getInstance($this, $this->partFactory);
130		}
131
132		/**
133		* Returns the DateConsumer singleton instance.
134		*
135		* @return \ZBateson\MailMimeParser\Header\Consumer\DateConsumer
136		*/
137	3	public function getDateConsumer()
138		{
139	3	return DateConsumer::getInstance($this, $this->partFactory);
140		}
141
142		/**
143		* Returns the ParameterConsumer singleton instance.
144		*
145		* @return \ZBateson\MailMimeParser\Header\Consumer\ParameterConsumer
146		*/
147	101	public function getParameterConsumer()
148		{
149	101	return ParameterConsumer::getInstance($this, $this->partFactory);
150		}
151
152		/**
153		* Returns the consumer instance corresponding to the passed part name of a
154		* Received header.
155		*
156		* @param string $partName
157		* @return \ZBateson\MailMimeParser\Header\Consumer\Received\FromConsumer
		0 ignored issues – show Bug introduced 2018-09-27 23:25 UTC by Report Bug Copy Issue Report The type `ZBateson\MailMimeParser\...r\Received\FromConsumer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
158		*/
159		public function getSubReceivedConsumer($partName)
160		{
161		if (empty($this->receivedConsumers[$partName])) {
162		$consumer = null;
163		if ($partName === 'from' \|\| $partName === 'by') {
164		$consumer = new DomainConsumer($this, $this->partFactory, $partName);
165		} else if ($partName === 'date') {
166		$consumer = new ReceivedDateConsumer($this, $this->partFactory);
167		} else {
168		$consumer = new GenericReceivedConsumer($this, $this->partFactory, $partName);
169		}
170		$this->receivedConsumers[$partName] = $consumer;
171		}
172		return $this->receivedConsumers[$partName];
173		}
174
175		/**
176		* Returns the ReceivedConsumer singleton instance.
177		*
178		* @return \ZBateson\MailMimeParser\Header\Consumer\ReceivedConsumer
179		*/
180		public function getReceivedConsumer()
181		{
182		return ReceivedConsumer::getInstance($this, $this->partFactory);
183		}
184
185		/**
186		* Returns the IdConsumer singleton instance.
187		*
188		* @return \ZBateson\MailMimeParser\Header\Consumer\IdConsumer
189		*/
190	10	public function getIdConsumer()
191		{
192	10	return IdConsumer::getInstance($this, $this->partFactory);
193		}
194
195		/**
196		* Returns the IdBaseConsumer singleton instance.
197		*
198		* @return \ZBateson\MailMimeParser\Header\Consumer\IdBaseConsumer
199		*/
200	10	public function getIdBaseConsumer()
201		{
202	10	return IdBaseConsumer::getInstance($this, $this->partFactory);
203		}
204		}
205

zbateson / mail-mime-parser

Push — master ( 2d7619...5b987a )

ConsumerService::getIdBaseConsumer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like