Issues in Message.php - Fixed Issues - Inspection of "Merge branch 'release/1.0.1'" - pgaultier/yii2-postmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1727f...e2607c )

by Philippe

created 2016-04-21 13:52 UTC

src/Message.php (3 issues)

Labels

Severity

Major 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Message.php
 *
 * PHP version 5.6+
 *
 * @author Philippe Gaultier <[email protected]>
 * @copyright 2010-2016 Philippe Gaultier
 * @license http://www.sweelix.net/license license
 * @version XXX
 * @link http://www.sweelix.net
 * @package sweelix\postmark
 */

namespace sweelix\postmark;


use yii\base\InvalidConfigException;
use yii\base\InvalidParamException;
use yii\base\NotSupportedException;
use yii\helpers\ArrayHelper;
use yii\mail\BaseMessage;
use Yii;
use yii\mail\MailerInterface;

/**
 * This component allow user to send an email
 *
 * @author Philippe Gaultier <[email protected]>
 * @copyright 2010-2016 Philippe Gaultier
 * @license http://www.sweelix.net/license license
 * @version XXX
 * @link http://www.sweelix.net
 * @package sweelix\postmark
 * @since XXX
 */
class Message extends BaseMessage
{
    /**
     * @var string from
     */
    protected $from;

    /**
     * @var array
     */
    protected $to = [];

    /**
     * @var string reply to
     */
    protected $replyTo;

    /**
     * @var array
     */
    protected $cc = [];

    /**
     * @var array
     */
    protected $bcc = [];

    /**
     * @var string
     */
    protected $subject;

    /**
     * @var string
     */
    protected $textBody;

    /**
     * @var string
     */
    protected $htmlBody;

    /**
     * @var array
     */
    protected $attachments = [];

    /**
     * @var string
     */
    protected $tag;

    /**
     * @var bool
     */
    protected $trackOpens = true;

    /**
     * @var array
     */
    protected $headers = [];

    /**
     * @var string
     */
    protected $templateId;

    /**
     * @var array
     */
    protected $templateModel;

    /**
     * @var bool
     */
    protected $inlineCss = true;

    /**
     * @inheritdoc
     */
    public function getCharset()
    {
        throw new NotSupportedException();
    }

    /**
     * @inheritdoc
     */
    public function setCharset($charset)
    {
        throw new NotSupportedException();
    }

    /**
     * @inheritdoc
     */
    public function getFrom()
    {
        return $this->extractEmails($this->from);
    }

    /**
     * @inheritdoc
     */
    public function setFrom($from)
    {
        $this->from = $from;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getTo()
    {
        return $this->extractEmails($this->to);

    }

    /**
     * @inheritdoc
     */
    public function setTo($to)
    {
        $this->to = $to;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getReplyTo()
    {
        return $this->extractEmails($this->replyTo);
    }

    /**
     * @inheritdoc
     */
    public function setReplyTo($replyTo)
    {
        $this->replyTo = $replyTo;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getCc()
    {
        return $this->extractEmails($this->cc);

    }

    /**
     * @inheritdoc
     */
    public function setCc($cc)
    {
        $this->cc = $cc;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getBcc()
    {
        return $this->extractEmails($this->bcc);

    }

    /**
     * @inheritdoc
     */
    public function setBcc($bcc)
    {
        $this->bcc = $bcc;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getSubject()
    {
        return $this->subject;
    }

    /**
     * @inheritdoc
     */
    public function setSubject($subject)
    {
        $this->subject = $subject;
        return $this;
    }

    /**
     * @return string|null text body of the message
     * @since XXX
     */
    public function getTextBody()
    {
        return $this->textBody;
    }

    /**
     * @inheritdoc
     */
    public function setTextBody($text)
    {
        $this->textBody = $text;
        return $this;
    }

    /**
     * @return string|null html body of the message
     * @since XXX
     */
    public function getHtmlBody()
    {
        return $this->htmlBody;
    }

    /**
     * @inheritdoc
     */
    public function setHtmlBody($html)
    {
        $this->htmlBody = $html;
        return $this;
    }

    /**
     * @return string tag associated to the email
     * @since XXX
     */
    public function getTag()
    {
        return $this->tag;
    }

    /**
     * @param string $tag tag which should be associated to the email
     * @return $this
     * @since XXX
     */
    public function setTag($tag)
    {
        $this->tag = $tag;
        return $this;
    }

    /**
     * @param bool $trackOpens define if mail should be tracked
     * @return $this
     * @since XXX
     */
    public function setTrackOpens($trackOpens)
    {
        $this->trackOpens = $trackOpens;
        return $this;
    }

    /**
     * @return bool tracking status
     * @since XXX
     */
    public function getTrackOpens()
    {
        return $this->trackOpens;
    }

    /**
     * @param integer $templateId template Id used. in this case, Subject / HtmlBody / TextBody are discarded
     * @return $this
     * @since XXX
     */
    public function setTemplateId($templateId)
    {
        $this->templateId = $templateId;
        return $this;
    }

    /**
     * @return integer|null current templateId
     * @since XXX
     */
    public function getTemplateId()
    {
        return $this->templateId;
    }

    /**
     * @param array $templateModel model associated with the template
     * @return $this
     * @since XXX
     */
    public function setTemplateModel($templateModel)
    {
        $this->templateModel = $templateModel;
        return $this;
    }

    /**
     * @return array current template model
     * @since XXX
     */
    public function getTemplateModel()
    {
        return $this->templateModel;
    }

    /**
     * @param bool $inlineCss define if css should be inlined
     * @return $this
     * @since XXX
     */
    public function setInlineCss($inlineCss)
    {
        $this->inlineCss = $inlineCss;
        return $this;
    }

    /**
     * @return bool define if css should be inlined
     * @since XXX
     */
    public function getInlineCss()
    {
        return $this->inlineCss;
    }

    /**
     * @param array $header add custom header to the mail
     * @since XXX
     */
    public function addHeader($header)
    {
        $this->headers[] = $header;
    }

    /**
     * @return array|null headers which should be added to the mail
     * @since XXX
     */
    public function getHeaders()
    {
        return empty($this->headers) ? null : $this->headers;
    }

    /**
     * @return array|null list of attachments
     * @since XXX
     */
    public function getAttachments()
    {
        return empty($this->attachments) ? null : $this->attachments;
    }

    /**
     * @inheritdoc
     */
    public function attach($fileName, array $options = [])
    {
        $attachment['Content'] = base64_encode(file_get_contents($fileName));
        if (!empty($options['fileName'])) {
            $attachment['Name'] = $options['fileName'];
        } else {
            $attachment['Name'] = pathinfo($fileName, PATHINFO_BASENAME);
        }
        if (!empty($options['contentType'])) {
            $attachment['ContentType'] = $options['contentType'];
        } else {
            $attachment['ContentType'] = 'application/octet-stream';
        }
        $this->attachments[] = $attachment;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function attachContent($content, array $options = [])
    {
        $attachment['Content'] = base64_encode($content);
        if (!empty($options['fileName'])) {
            $attachment['Name'] = $options['fileName'];
        } else {
            throw new InvalidParamException('Filename is missing');
        }
        if (!empty($options['contentType'])) {
            $attachment['ContentType'] = $options['contentType'];
        } else {
            $attachment['ContentType'] = 'application/octet-stream';
        }
        $this->attachments[] = $attachment;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function embed($fileName, array $options = [])
    {
        $embed['Content'] = base64_encode(file_get_contents($fileName));
        if (!empty($options['fileName'])) {
            $embed['Name'] = $options['fileName'];
        } else {
            $embed['Name'] = pathinfo($fileName, PATHINFO_BASENAME);
        }
        if (!empty($options['contentType'])) {
            $embed['ContentType'] = $options['contentType'];
        } else {
            $embed['ContentType'] = 'application/octet-stream';
        }
        $embed['ContentID'] = 'cid:' . uniqid();
        $this->attachments[] = $embed;
        return $embed['ContentID'];
    }

    /**
     * @inheritdoc
     */
    public function embedContent($content, array $options = [])
    {
        $embed['Content'] = base64_encode($content);
        if (!empty($options['fileName'])) {
            $embed['Name'] = $options['fileName'];
        } else {
            throw new InvalidParamException('Filename is missing');
        }
        if (!empty($options['contentType'])) {
            $embed['ContentType'] = $options['contentType'];
        } else {
            $embed['ContentType'] = 'application/octet-stream';
        }
        $embed['ContentID'] = 'cid:' . uniqid();
        $this->attachments[] = $embed;
        return $embed['ContentID'];
    }

    /**
     * @inheritdoc
     * @todo make real serialization to make message compliant with PostmarkAPI
     */
    public function toString()
    {
        return serialize($this);
    }


    /**
     * @param array|string $emailsData email can be defined as string. In this case no transformation is done
     *                                 or as an array ['[email protected]', '[email protected]' => 'Email 2']
     * @return string|null
     * @since XXX
     */
    private function extractEmails($emailsData)
    {
        $emails = null;
        if (empty($emailsData) === false) {
            if (is_array($emailsData) === true) {
                foreach ($emailsData as $key => $email) {
                    if (is_int($key) === true) {
                        $emails[] = $email;
                    } else {
                        if (preg_match('/[.,:]/', $email) > 0) {
                            $email = '"'. $email .'"';
                        }
                        $emails[] = $email . ' ' . '<' . $key . '>';
                    }
                }
                $emails = implode(', ', $emails);
            } elseif (is_string($emailsData) === true) {
                $emails = $emailsData;
            }
        }
        return $emails;
    }


}

1		<?php
2		/**
3		* Message.php
4		*
5		* PHP version 5.6+
6		*
7		* @author Philippe Gaultier <[email protected]>
8		* @copyright 2010-2016 Philippe Gaultier
9		* @license http://www.sweelix.net/license license
10		* @version XXX
11		* @link http://www.sweelix.net
12		* @package sweelix\postmark
13		*/
14
15		namespace sweelix\postmark;
16
17
18		use yii\base\InvalidConfigException;
19		use yii\base\InvalidParamException;
20		use yii\base\NotSupportedException;
21		use yii\helpers\ArrayHelper;
22		use yii\mail\BaseMessage;
23		use Yii;
24		use yii\mail\MailerInterface;
25
26		/**
27		* This component allow user to send an email
28		*
29		* @author Philippe Gaultier <[email protected]>
30		* @copyright 2010-2016 Philippe Gaultier
31		* @license http://www.sweelix.net/license license
32		* @version XXX
33		* @link http://www.sweelix.net
34		* @package sweelix\postmark
35		* @since XXX
36		*/
37		class Message extends BaseMessage
38		{
39		/**
40		* @var string from
41		*/
42		protected $from;
43
44		/**
45		* @var array
46		*/
47		protected $to = [];
48
49		/**
50		* @var string reply to
51		*/
52		protected $replyTo;
53
54		/**
55		* @var array
56		*/
57		protected $cc = [];
58
59		/**
60		* @var array
61		*/
62		protected $bcc = [];
63
64		/**
65		* @var string
66		*/
67		protected $subject;
68
69		/**
70		* @var string
71		*/
72		protected $textBody;
73
74		/**
75		* @var string
76		*/
77		protected $htmlBody;
78
79		/**
80		* @var array
81		*/
82		protected $attachments = [];
83
84		/**
85		* @var string
86		*/
87		protected $tag;
88
89		/**
90		* @var bool
91		*/
92		protected $trackOpens = true;
93
94		/**
95		* @var array
96		*/
97		protected $headers = [];
98
99		/**
100		* @var string
101		*/
102		protected $templateId;
103
104		/**
105		* @var array
106		*/
107		protected $templateModel;
108
109		/**
110		* @var bool
111		*/
112		protected $inlineCss = true;
113
114		/**
115		* @inheritdoc
116		*/
117	1	public function getCharset()
118		{
119	1	throw new NotSupportedException();
120		}
121
122		/**
123		* @inheritdoc
124		*/
125	1	public function setCharset($charset)
126		{
127	1	throw new NotSupportedException();
128		}
129
130		/**
131		* @inheritdoc
132		*/
133	1	public function getFrom()
134		{
135	1	return $this->extractEmails($this->from);
136		}
137
138		/**
139		* @inheritdoc
140		*/
141	3	public function setFrom($from)
142		{
143	3	$this->from = $from;
144	3	return $this;
145		}
146
147		/**
148		* @inheritdoc
149		*/
150	3	public function getTo()
151		{
152	3	return $this->extractEmails($this->to);
		0 ignored issues – show Bug Compatibility introduced 2016-04-21 12:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$this->extractEmails($this->to);` of type `string\|null` adds the type `string` to the return on line 152 which is incompatible with the return type declared by the interface `yii\mail\MessageInterface::getTo` of type `array`. Loading history...
153		}
154
155		/**
156		* @inheritdoc
157		*/
158	3	public function setTo($to)
159		{
160	3	$this->to = $to;
161	3	return $this;
162		}
163
164		/**
165		* @inheritdoc
166		*/
167	1	public function getReplyTo()
168		{
169	1	return $this->extractEmails($this->replyTo);
170		}
171
172		/**
173		* @inheritdoc
174		*/
175	1	public function setReplyTo($replyTo)
176		{
177	1	$this->replyTo = $replyTo;
178	1	return $this;
179		}
180
181		/**
182		* @inheritdoc
183		*/
184	1	public function getCc()
185		{
186	1	return $this->extractEmails($this->cc);
		0 ignored issues – show Bug Compatibility introduced 2016-04-21 12:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$this->extractEmails($this->cc);` of type `string\|null` adds the type `string` to the return on line 186 which is incompatible with the return type declared by the interface `yii\mail\MessageInterface::getCc` of type `array`. Loading history...
187		}
188
189		/**
190		* @inheritdoc
191		*/
192	1	public function setCc($cc)
193		{
194	1	$this->cc = $cc;
195	1	return $this;
196		}
197
198		/**
199		* @inheritdoc
200		*/
201	1	public function getBcc()
202		{
203	1	return $this->extractEmails($this->bcc);
		0 ignored issues – show Bug Compatibility introduced 2016-04-21 12:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$this->extractEmails($this->bcc);` of type `string\|null` adds the type `string` to the return on line 203 which is incompatible with the return type declared by the interface `yii\mail\MessageInterface::getBcc` of type `array`. Loading history...
204		}
205
206		/**
207		* @inheritdoc
208		*/
209	1	public function setBcc($bcc)
210		{
211	1	$this->bcc = $bcc;
212	1	return $this;
213		}
214
215		/**
216		* @inheritdoc
217		*/
218	3	public function getSubject()
219		{
220	3	return $this->subject;
221		}
222
223		/**
224		* @inheritdoc
225		*/
226	2	public function setSubject($subject)
227		{
228	2	$this->subject = $subject;
229	2	return $this;
230		}
231
232		/**
233		* @return string\|null text body of the message
234		* @since XXX
235		*/
236	1	public function getTextBody()
237		{
238	1	return $this->textBody;
239		}
240
241		/**
242		* @inheritdoc
243		*/
244	2	public function setTextBody($text)
245		{
246	2	$this->textBody = $text;
247	2	return $this;
248		}
249
250		/**
251		* @return string\|null html body of the message
252		* @since XXX
253		*/
254	1	public function getHtmlBody()
255		{
256	1	return $this->htmlBody;
257		}
258
259		/**
260		* @inheritdoc
261		*/
262	1	public function setHtmlBody($html)
263		{
264	1	$this->htmlBody = $html;
265	1	return $this;
266		}
267
268		/**
269		* @return string tag associated to the email
270		* @since XXX
271		*/
272	1	public function getTag()
273		{
274	1	return $this->tag;
275		}
276
277		/**
278		* @param string $tag tag which should be associated to the email
279		* @return $this
280		* @since XXX
281		*/
282	1	public function setTag($tag)
283		{
284	1	$this->tag = $tag;
285	1	return $this;
286		}
287
288		/**
289		* @param bool $trackOpens define if mail should be tracked
290		* @return $this
291		* @since XXX
292		*/
293	1	public function setTrackOpens($trackOpens)
294		{
295	1	$this->trackOpens = $trackOpens;
296	1	return $this;
297		}
298
299		/**
300		* @return bool tracking status
301		* @since XXX
302		*/
303	1	public function getTrackOpens()
304		{
305	1	return $this->trackOpens;
306		}
307
308		/**
309		* @param integer $templateId template Id used. in this case, Subject / HtmlBody / TextBody are discarded
310		* @return $this
311		* @since XXX
312		*/
313	2	public function setTemplateId($templateId)
314		{
315	2	$this->templateId = $templateId;
316	2	return $this;
317		}
318
319		/**
320		* @return integer\|null current templateId
321		* @since XXX
322		*/
323	1	public function getTemplateId()
324		{
325	1	return $this->templateId;
326		}
327
328		/**
329		* @param array $templateModel model associated with the template
330		* @return $this
331		* @since XXX
332		*/
333	2	public function setTemplateModel($templateModel)
334		{
335	2	$this->templateModel = $templateModel;
336	2	return $this;
337		}
338
339		/**
340		* @return array current template model
341		* @since XXX
342		*/
343	1	public function getTemplateModel()
344		{
345	1	return $this->templateModel;
346		}
347
348		/**
349		* @param bool $inlineCss define if css should be inlined
350		* @return $this
351		* @since XXX
352		*/
353	1	public function setInlineCss($inlineCss)
354		{
355	1	$this->inlineCss = $inlineCss;
356	1	return $this;
357		}
358
359		/**
360		* @return bool define if css should be inlined
361		* @since XXX
362		*/
363	1	public function getInlineCss()
364		{
365	1	return $this->inlineCss;
366		}
367
368		/**
369		* @param array $header add custom header to the mail
370		* @since XXX
371		*/
372	1	public function addHeader($header)
373		{
374	1	$this->headers[] = $header;
375	1	}
376
377		/**
378		* @return array\|null headers which should be added to the mail
379		* @since XXX
380		*/
381	1	public function getHeaders()
382		{
383	1	return empty($this->headers) ? null : $this->headers;
384		}
385
386		/**
387		* @return array\|null list of attachments
388		* @since XXX
389		*/
390	1	public function getAttachments()
391		{
392	1	return empty($this->attachments) ? null : $this->attachments;
393		}
394
395		/**
396		* @inheritdoc
397		*/
398	1	public function attach($fileName, array $options = [])
399		{
400	1	$attachment['Content'] = base64_encode(file_get_contents($fileName));
401	1	if (!empty($options['fileName'])) {
402	1	$attachment['Name'] = $options['fileName'];
403	1	} else {
404	1	$attachment['Name'] = pathinfo($fileName, PATHINFO_BASENAME);
405		}
406	1	if (!empty($options['contentType'])) {
407	1	$attachment['ContentType'] = $options['contentType'];
408	1	} else {
409	1	$attachment['ContentType'] = 'application/octet-stream';
410		}
411	1	$this->attachments[] = $attachment;
412	1	return $this;
413		}
414
415		/**
416		* @inheritdoc
417		*/
418	2	public function attachContent($content, array $options = [])
419		{
420	2	$attachment['Content'] = base64_encode($content);
421	2	if (!empty($options['fileName'])) {
422	1	$attachment['Name'] = $options['fileName'];
423	1	} else {
424	1	throw new InvalidParamException('Filename is missing');
425		}
426	1	if (!empty($options['contentType'])) {
427	1	$attachment['ContentType'] = $options['contentType'];
428	1	} else {
429	1	$attachment['ContentType'] = 'application/octet-stream';
430		}
431	1	$this->attachments[] = $attachment;
432	1	return $this;
433		}
434
435		/**
436		* @inheritdoc
437		*/
438	1	public function embed($fileName, array $options = [])
439		{
440	1	$embed['Content'] = base64_encode(file_get_contents($fileName));
441	1	if (!empty($options['fileName'])) {
442	1	$embed['Name'] = $options['fileName'];
443	1	} else {
444	1	$embed['Name'] = pathinfo($fileName, PATHINFO_BASENAME);
445		}
446	1	if (!empty($options['contentType'])) {
447	1	$embed['ContentType'] = $options['contentType'];
448	1	} else {
449	1	$embed['ContentType'] = 'application/octet-stream';
450		}
451	1	$embed['ContentID'] = 'cid:' . uniqid();
452	1	$this->attachments[] = $embed;
453	1	return $embed['ContentID'];
454		}
455
456		/**
457		* @inheritdoc
458		*/
459	2	public function embedContent($content, array $options = [])
460		{
461	2	$embed['Content'] = base64_encode($content);
462	2	if (!empty($options['fileName'])) {
463	1	$embed['Name'] = $options['fileName'];
464	1	} else {
465	1	throw new InvalidParamException('Filename is missing');
466		}
467	1	if (!empty($options['contentType'])) {
468	1	$embed['ContentType'] = $options['contentType'];
469	1	} else {
470	1	$embed['ContentType'] = 'application/octet-stream';
471		}
472	1	$embed['ContentID'] = 'cid:' . uniqid();
473	1	$this->attachments[] = $embed;
474	1	return $embed['ContentID'];
475		}
476
477		/**
478		* @inheritdoc
479		* @todo make real serialization to make message compliant with PostmarkAPI
480		*/
481		public function toString()
482		{
483		return serialize($this);
484		}
485
486
487		/**
488		* @param array\|string $emailsData email can be defined as string. In this case no transformation is done
489		* or as an array ['[email protected]', '[email protected]' => 'Email 2']
490		* @return string\|null
491		* @since XXX
492		*/
493	3	private function extractEmails($emailsData)
494		{
495	3	$emails = null;
496	3	if (empty($emailsData) === false) {
497	3	if (is_array($emailsData) === true) {
498	1	foreach ($emailsData as $key => $email) {
499	1	if (is_int($key) === true) {
500	1	$emails[] = $email;
501	1	} else {
502	1	if (preg_match('/[.,:]/', $email) > 0) {
503	1	$email = '"'. $email .'"';
504	1	}
505	1	$emails[] = $email . ' ' . '<' . $key . '>';
506		}
507	1	}
508	1	$emails = implode(', ', $emails);
509	3	} elseif (is_string($emailsData) === true) {
510	3	$emails = $emailsData;
511	3	}
512	3	}
513	3	return $emails;
514		}
515
516
517		}

pgaultier / yii2-postmark

Push — master ( a1727f...e2607c )

src/Message.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like