Message::addHeader() - Code Metrics - slickframework/mail - Measure and Improve Code Quality continuously with Scrutinizer

Message::addHeader() A
last analyzed 2016-08-04 18:35 UTC

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	1

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

<?php

/**
 * This file is part of slick/mail package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mail;

use Slick\Mail\Header\AddressList;
use Slick\Mail\Header\AddressListInterface;
use Slick\Mail\Header\GenericHeader;
use Slick\Mail\Header\HeaderInterface;

/**
 * Wraps an e-mail message
 *
 * @package Slick\Mail
 * @author  Filipe Silva <[email protected]>
 */
class Message implements MessageInterface
{

    /**
     * @var HeaderInterface[]
     */
    protected $headers;

    /**
     * @var MessageBodyInterface
     */
    protected $body;

    /**
     * Is the message valid?
     *
     * If we don't have any From addresses, we're invalid, according
     * to RFC2822.
     *
     * @return bool
     */
    public function isValid()
    {
        /** @var AddressList $from */
        $from = $this->getHeader('From', new AddressList('From'));
        return !$from->isEmpty();
    }

    /**
     * Access headers collection
     *
     * Lazy-loads if not already attached.
     *
     * @return HeaderInterface[]
     */
    public function getHeaders()
    {
        if (null == $this->headers) {
            $this->headers['Date'] = New GenericHeader('Date', date('r'));
        }
        return $this->headers;
    }

    /**
     * Adds an header with provided value
     *
     * If key already exists it will be overridden
     *
     * @param string $name
     * @param HeaderInterface $header
     *
     * @return MessageInterface
     */
    public function addHeader($name, HeaderInterface $header)
    {
        $headers = $this->getHeaders();
        $headers[$name] = $header;
        $this->headers = $headers;

        return $this;
    }

    /**
     * Set (overwrite) From addresses
     *
     * @param  string $emailAddress
     * @param  string|null $name
     *
     * @return MessageInterface
     */
    public function setFrom($emailAddress, $name = null)

    {
        $address = new AddressList\Address($emailAddress, $name);

        $from = (new AddressList('From'))->add($address);
        $this->addHeader('From', $from);
        $sender = new GenericHeader('Sender', (string) $address);
        $this->addHeader('Sender', $sender);
        return $this;
    }

    /**
     * Access the address list of the From header.
     *
     * @return string
     */
    public function getFromAddressList()
    {
        /** @var AddressList $from */
        $from = $this->getHeader('From', new AddressList('From'));
        return trim(str_replace('From:', '', $from->toString()));
    }

    /**
     * Overwrite the address list in the To recipients
     *
     * @param  string $email
     * @param  string|null $name
     *
     * @return MessageInterface
     */
    public function setTo($email, $name = null)
    {
        $toHeader = (new AddressList('To'))
            ->add(new AddressList\Address($email, $name));

        $this->addHeader('To', $toHeader);
        return $this;
    }

    /**
     * Access the address list of the To header.
     *
     * @return string
     */
    public function getToAddressList()
    {
        /** @var AddressList $from */
        $from = $this->getHeader('To', new AddressList('To'));
        return trim(str_replace('To:', '', $from->toString()));
    }

    /**
     * Add one or more addresses to the To recipients
     *
     * Appends to the list.
     *
     * @param  string $email
     * @param  null|string $name
     *
     * @return MessageInterface
     */
    public function addTo($email, $name = null)

    {
        $address = new AddressList\Address($email, $name);

        /** @var AddressListInterface $toHeader */
        $toHeader = $this->getHeader('To', new AddressList('To'));
        $toHeader->add($address);
        $this->addHeader('To', $toHeader);
        return $this;
    }

    /**
     * Add a "Cc" address
     *
     * @param  string $email
     * @param  null|string $name
     *
     * @return MessageInterface
     */
    public function addCc($email, $name = null)

    {
        /** @var AddressList $header */
        $header = $this->getHeader('Cc', new AddressList('Cc'));
        $header->add(new AddressList\Address($email, $name));

        return $this;
    }

    /**
     * Add a "Bcc" address
     *
     * @param  string $email
     * @param  null|string $name
     *
     * @return MessageInterface
     */
    public function addBcc($email, $name = null)

    {
        /** @var AddressList $header */
        $header = $this->getHeader('Bcc', new AddressList('Bcc'));
        $header->add(new AddressList\Address($email, $name));

        return $this;
    }

    /**
     * Add one or more addresses to the Reply-To recipients
     *
     * Appends to the list.
     *
     * @param  string $email
     * @param  null|string $name
     *
     * @return MessageInterface
     */
    public function addReplyTo($email, $name = null)

    {
        /** @var AddressList $header */
        $header = $this->getHeader('Reply-To', new AddressList('Reply-To'));
        $header->add(new AddressList\Address($email, $name));

        return $this;
    }

    /**
     * Set the message subject header value
     *
     * @param  string $subject
     *
     * @return MessageInterface
     */
    public function setSubject($subject)
    {
        $subject = new GenericHeader('Subject', $subject);
        $this->addHeader('Subject', $subject);
        return $this;
    }

    /**
     * Get the message subject header value
     *
     * @return null|string
     */
    public function getSubject()
    {
        $subject = $this->getHeader('Subject');
        return $subject->getValue();
    }

    /**
     * Set the message body
     *
     * @param  MessageBodyInterface $body
     *
     * @return MessageInterface
     */
    public function setBody(MessageBodyInterface $body)
    {
        $body->setMailMessage($this);
        $this->body = $body;
        return $this;
    }

    /**
     * Get the string-serialized message body text
     *
     * @return string
     */
    public function getBodyText()
    {
        $text = '';
        if (null != $this->body) {
            $text = $this->body->getBodyText();
        }
        return $text;
    }

    /**
     * Gets the header with provided name.
     *
     * If no header was set with that name, the default value will be
     * assign to a new header and returned.
     *
     * @param string $name
     * @param mixed $default
     *
     * @return HeaderInterface
     */
    protected function getHeader($name, $default = '')
    {
        if (array_key_exists($name, $this->getHeaders())) {
            return $this->headers[$name];
        }

        $this->headers[$name] = $default;
        return $default;
    }
}

1			<?php
2
3			/**
4			* This file is part of slick/mail package
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace Slick\Mail;
11
12			use Slick\Mail\Header\AddressList;
13			use Slick\Mail\Header\AddressListInterface;
14			use Slick\Mail\Header\GenericHeader;
15			use Slick\Mail\Header\HeaderInterface;
16
17			/**
18			* Wraps an e-mail message
19			*
20			* @package Slick\Mail
21			* @author Filipe Silva <[email protected]>
22			*/
23			class Message implements MessageInterface
24			{
25
26			/**
27			* @var HeaderInterface[]
28			*/
29			protected $headers;
30
31			/**
32			* @var MessageBodyInterface
33			*/
34			protected $body;
35
36			/**
37			* Is the message valid?
38			*
39			* If we don't have any From addresses, we're invalid, according
40			* to RFC2822.
41			*
42			* @return bool
43			*/
44	2		public function isValid()
45			{
46			/** @var AddressList $from */
47	2		$from = $this->getHeader('From', new AddressList('From'));
48	2		return !$from->isEmpty();
49			}
50
51			/**
52			* Access headers collection
53			*
54			* Lazy-loads if not already attached.
55			*
56			* @return HeaderInterface[]
57			*/
58	26		public function getHeaders()
59			{
60	26		if (null == $this->headers) {
61	8		$this->headers['Date'] = New GenericHeader('Date', date('r'));
62	4		}
63	26		return $this->headers;
64			}
65
66			/**
67			* Adds an header with provided value
68			*
69			* If key already exists it will be overridden
70			*
71			* @param string $name
72			* @param HeaderInterface $header
73			*
74			* @return MessageInterface
75			*/
76	12		public function addHeader($name, HeaderInterface $header)
77			{
78	12		$headers = $this->getHeaders();
79	12		$headers[$name] = $header;
80	12		$this->headers = $headers;
			0 ignored issues – show Documentation Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$headers` of type `array<string,object<Slic...eader\HeaderInterface>>` is incompatible with the declared type `array<integer,object<Sli...eader\HeaderInterface>>` of property `$headers`. 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...
81	12		return $this;
82			}
83
84			/**
85			* Set (overwrite) From addresses
86			*
87			* @param string $emailAddress
88			* @param string\|null $name
89			*
90			* @return MessageInterface
91			*/
92	6	View Code Duplication	public function setFrom($emailAddress, $name = null)
			0 ignored issues – show Duplication introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
93			{
94	6		$address = new AddressList\Address($emailAddress, $name);
			0 ignored issues – show Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$name` defined by parameter `$name` on line 92 can also be of type `string`; however, `Slick\Mail\Header\Addres...\Address::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
95	6		$from = (new AddressList('From'))->add($address);
96	6		$this->addHeader('From', $from);
97	6		$sender = new GenericHeader('Sender', (string) $address);
98	6		$this->addHeader('Sender', $sender);
99	6		return $this;
100			}
101
102			/**
103			* Access the address list of the From header.
104			*
105			* @return string
106			*/
107	4		public function getFromAddressList()
108			{
109			/** @var AddressList $from */
110	4		$from = $this->getHeader('From', new AddressList('From'));
111	4		return trim(str_replace('From:', '', $from->toString()));
112			}
113
114			/**
115			* Overwrite the address list in the To recipients
116			*
117			* @param string $email
118			* @param string\|null $name
119			*
120			* @return MessageInterface
121			*/
122	2		public function setTo($email, $name = null)
123			{
124	2		$toHeader = (new AddressList('To'))
125	2		->add(new AddressList\Address($email, $name));
			0 ignored issues – show Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$name` defined by parameter `$name` on line 122 can also be of type `string`; however, `Slick\Mail\Header\Addres...\Address::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
126	2		$this->addHeader('To', $toHeader);
127	2		return $this;
128			}
129
130			/**
131			* Access the address list of the To header.
132			*
133			* @return string
134			*/
135	6		public function getToAddressList()
136			{
137			/** @var AddressList $from */
138	6		$from = $this->getHeader('To', new AddressList('To'));
139	6		return trim(str_replace('To:', '', $from->toString()));
140			}
141
142			/**
143			* Add one or more addresses to the To recipients
144			*
145			* Appends to the list.
146			*
147			* @param string $email
148			* @param null\|string $name
149			*
150			* @return MessageInterface
151			*/
152	8	View Code Duplication	public function addTo($email, $name = null)
			0 ignored issues – show Duplication introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
153			{
154	8		$address = new AddressList\Address($email, $name);
			0 ignored issues – show Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$name` defined by parameter `$name` on line 152 can also be of type `string`; however, `Slick\Mail\Header\Addres...\Address::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
155			/** @var AddressListInterface $toHeader */
156	8		$toHeader = $this->getHeader('To', new AddressList('To'));
157	8		$toHeader->add($address);
158	8		$this->addHeader('To', $toHeader);
159	8		return $this;
160			}
161
162			/**
163			* Add a "Cc" address
164			*
165			* @param string $email
166			* @param null\|string $name
167			*
168			* @return MessageInterface
169			*/
170	2	View Code Duplication	public function addCc($email, $name = null)
			0 ignored issues – show Duplication introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
171			{
172			/** @var AddressList $header */
173	2		$header = $this->getHeader('Cc', new AddressList('Cc'));
174	2		$header->add(new AddressList\Address($email, $name));
			0 ignored issues – show Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$name` defined by parameter `$name` on line 170 can also be of type `string`; however, `Slick\Mail\Header\Addres...\Address::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
175	2		return $this;
176			}
177
178			/**
179			* Add a "Bcc" address
180			*
181			* @param string $email
182			* @param null\|string $name
183			*
184			* @return MessageInterface
185			*/
186	2	View Code Duplication	public function addBcc($email, $name = null)
			0 ignored issues – show Duplication introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
187			{
188			/** @var AddressList $header */
189	2		$header = $this->getHeader('Bcc', new AddressList('Bcc'));
190	2		$header->add(new AddressList\Address($email, $name));
			0 ignored issues – show Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$name` defined by parameter `$name` on line 186 can also be of type `string`; however, `Slick\Mail\Header\Addres...\Address::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
191	2		return $this;
192			}
193
194			/**
195			* Add one or more addresses to the Reply-To recipients
196			*
197			* Appends to the list.
198			*
199			* @param string $email
200			* @param null\|string $name
201			*
202			* @return MessageInterface
203			*/
204	2	View Code Duplication	public function addReplyTo($email, $name = null)
			0 ignored issues – show Duplication introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
205			{
206			/** @var AddressList $header */
207	2		$header = $this->getHeader('Reply-To', new AddressList('Reply-To'));
208	2		$header->add(new AddressList\Address($email, $name));
			0 ignored issues – show Bug introduced 2016-08-04 18:33 UTC by Report Bug Copy Issue Report It seems like `$name` defined by parameter `$name` on line 204 can also be of type `string`; however, `Slick\Mail\Header\Addres...\Address::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
209	2		return $this;
210			}
211
212			/**
213			* Set the message subject header value
214			*
215			* @param string $subject
216			*
217			* @return MessageInterface
218			*/
219	6		public function setSubject($subject)
220			{
221	6		$subject = new GenericHeader('Subject', $subject);
222	6		$this->addHeader('Subject', $subject);
223	6		return $this;
224			}
225
226			/**
227			* Get the message subject header value
228			*
229			* @return null\|string
230			*/
231	4		public function getSubject()
232			{
233	4		$subject = $this->getHeader('Subject');
234	4		return $subject->getValue();
235			}
236
237			/**
238			* Set the message body
239			*
240			* @param MessageBodyInterface $body
241			*
242			* @return MessageInterface
243			*/
244	8		public function setBody(MessageBodyInterface $body)
245			{
246	8		$body->setMailMessage($this);
247	8		$this->body = $body;
248	8		return $this;
249			}
250
251			/**
252			* Get the string-serialized message body text
253			*
254			* @return string
255			*/
256	6		public function getBodyText()
257			{
258	6		$text = '';
259	6		if (null != $this->body) {
260	6		$text = $this->body->getBodyText();
261	3		}
262	6		return $text;
263			}
264
265			/**
266			* Gets the header with provided name.
267			*
268			* If no header was set with that name, the default value will be
269			* assign to a new header and returned.
270			*
271			* @param string $name
272			* @param mixed $default
273			*
274			* @return HeaderInterface
275			*/
276	20		protected function getHeader($name, $default = '')
277			{
278	20		if (array_key_exists($name, $this->getHeaders())) {
279	10		return $this->headers[$name];
280			}
281
282	14		$this->headers[$name] = $default;
283	14		return $default;
284			}
285			}

slickframework / mail

Message::addHeader() A last analyzed 2016-08-04 18:35 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Message::addHeader() A
last analyzed 2016-08-04 18:35 UTC