SwiftTwigMailTemplate::setReplyToName() - Code Metrics - Inspection of "Allowing generating mail from text mails only" - thecodingmachine/swift-twig-mail-template - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 5.0 (#3)

by David

created 2016-07-25 12:04 UTC

SwiftTwigMailTemplate::setReplyToName() A

↳ Parent: SwiftTwigMailTemplate

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace TheCodingMachine\Mail\Template;

use TheCodingMachine\Mail\SwiftMailTemplate;

class SwiftTwigMailTemplate implements SwiftMailTemplate
{
    /**
     * @var \Twig_Environment
     */
    protected $twigEnvironment;

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

    /**
     * @var string|array
     */
    protected $fromAddresses;

    /**
     * @var string
     */
    protected $fromName = null;

    /**
     * @var string|array
     */
    protected $toAddresses;

    /**
     * @var string
     */
    protected $toName = null;

    /**
     * @var string|array
     */
    protected $bccAddresses;

    /**
     * @var string
     */
    protected $bccName = null;

    /**
     * @var string|array
     */
    protected $ccAddresses;

    /**
     * @var string
     */
    protected $ccName = null;

    /**
     * @var string|array
     */
    protected $replyToAddresses;

    /**
     * @var string
     */
    protected $replyToName = null;

    /**
     * @var int
     */
    protected $maxLineLength = 1000;

    /**
     * @var int
     */
    protected $priority;

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

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

    /**
     * SwiftTwigMailGenerator constructor.
     *
     * @param \Twig_Environment $twig_Environment
     * @param string            $twigPath
     */
    public function __construct(\Twig_Environment $twig_Environment, string $twigPath)
    {
        $this->twigEnvironment = $twig_Environment;
        $this->twigPath = $twigPath;
    }

    /**
     * @param array $data
     *
     * @return \Swift_Message
     */
    public function renderMail(array $data = []) :\Swift_Message
    {
        $mail = new \Swift_Message();

        $twigEnvironment = clone $this->twigEnvironment;
        $function = new \Twig_SimpleFunction('embedImage', function ($imgPath) use ($mail) {
            return $mail->embed(\Swift_Image::fromPath($imgPath));
        });
        $twigEnvironment->addFunction($function);

        $template = $twigEnvironment->loadTemplate($this->twigPath);

        if (!$template->hasBlock('subject') || (!$template->hasBlock('body_html') && !$template->hasBlock('body_text'))) {
            throw MissingBlockException::missingBlock($template->getBlockNames());
        }

        $subject = $template->renderBlock('subject', $data);

        $mail->setSubject($subject);

        if ($template->hasBlock('body_html')) {
            $bodyHtml = $template->renderBlock('body_html', $data);

            if (!$template->hasBlock('body_text')) {
                $bodyText = $this->removeHtml($bodyHtml);
            } else {
                $bodyText = $template->renderBlock('body_text', $data);

            }

            $mail->setBody($bodyHtml, 'text/html');
            $mail->addPart($bodyText, 'text/plain');
        } else {
            $bodyText = $template->renderBlock('body_text', $data);


            $mail->setBody($bodyText, 'text/plain');
        }

        switch (true) {

            case $this->fromAddresses:

                $mail->setFrom($this->fromAddresses, $this->fromName);
                $mail->setSender($this->fromAddresses, $this->fromName);
            case $this->toAddresses:

                $mail->setTo($this->toAddresses, $this->toName);
            case $this->bccAddresses:

                $mail->setBcc($this->bccAddresses, $this->bccName);
            case $this->ccAddresses:

                $mail->setCc($this->ccAddresses, $this->ccName);
            case $this->replyToAddresses:

                $mail->setReplyTo($this->replyToAddresses, $this->replyToName);
            case $this->maxLineLength:

                $mail->setMaxLineLength($this->maxLineLength);
            case $this->priority:

                $mail->setPriority($this->priority);
            case $this->readReceiptTo:

                $mail->setReadReceiptTo($this->readReceiptTo);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            case $this->returnPath:

                $mail->setReturnPath($this->returnPath);
            default:
                break;
        }

        return $mail;
    }

    /**
     * @param array|string $fromAddresses
     */
    public function setFromAddresses($fromAddresses)
    {
        $this->fromAddresses = $fromAddresses;
    }

    /**
     * @param string $fromName
     */
    public function setFromName($fromName)
    {
        $this->fromName = $fromName;
    }

    /**
     * @param array|string $toAddresses
     */
    public function setToAddresses($toAddresses)
    {
        $this->toAddresses = $toAddresses;
    }

    /**
     * @param string $toName
     */
    public function setToName($toName)
    {
        $this->toName = $toName;
    }

    /**
     * @param array|string $bccAddresses
     */
    public function setBccAddresses($bccAddresses)
    {
        $this->bccAddresses = $bccAddresses;
    }

    /**
     * @param string $bccName
     */
    public function setBccName($bccName)
    {
        $this->bccName = $bccName;
    }

    /**
     * @param array|string $ccAddresses
     */
    public function setCcAddresses($ccAddresses)
    {
        $this->ccAddresses = $ccAddresses;
    }

    /**
     * @param string $ccName
     */
    public function setCcName($ccName)
    {
        $this->ccName = $ccName;
    }

    /**
     * @param array|string $replyToAddresses
     */
    public function setReplyToAddresses($replyToAddresses)
    {
        $this->replyToAddresses = $replyToAddresses;
    }

    /**
     * @param string $replyToName
     */
    public function setReplyToName($replyToName)
    {
        $this->replyToName = $replyToName;
    }

    /**
     * @param int $maxLineLength
     */
    public function setMaxLineLength($maxLineLength)
    {
        $this->maxLineLength = $maxLineLength;
    }

    /**
     * @param int $priority
     */
    public function setPriority($priority)
    {
        $this->priority = $priority;
    }

    /**
     * @param string $readReceiptTo
     */
    public function setReadReceiptTo($readReceiptTo)
    {
        $this->readReceiptTo = $readReceiptTo;
    }

    /**
     * @param string $returnPath
     */
    public function setReturnPath($returnPath)
    {
        $this->returnPath = $returnPath;
    }

    /**
     * Removes the HTML tags from the text.
     *
     * @param string $s
     * @param string $keep   The list of tags to keep
     * @param string $expand The list of tags to remove completely, along their content
     */
    private function removeHtml(string $s, string $keep = '', string $expand = 'script|style|noframes|select|option') :string
    {
        /**///prep the string
        $s = ' '.$s;

        /**///initialize keep tag logic
        if (strlen($keep) > 0) {
            $k = explode('|', $keep);
            $s = $this->keepTag($s, $k, '<', '[{(');
        }
        //begin removal
        /**///remove comment blocks
        $s = $this->removeElement($s, '<!--', '-->');

        /**///remove tags with content between them
        if (strlen($expand) > 0) {
            $e = explode('|', $expand);
            $count = count($e);
            $pos = [];
            $len = [];
            for ($i = 0;$i < $count;++$i) {
                while (stripos($s, '<'.$e[$i]) > 0) {
                    $len[1] = strlen('<'.$e[$i]);
                    $pos[1] = stripos($s, '<'.$e[$i]);
                    $pos[2] = stripos($s, $e[$i].'>', $pos[1] + $len[1]);
                    $len[2] = $pos[2] - $pos[1] + $len[1];
                    $x = substr($s, $pos[1], $len[2]);
                    $s = str_replace($x, '', $s);
                }
            }
        }

        /**///remove remaining tags
        $s = $this->removeElement($s, '<', '>');

        /**///finalize keep tag
        if (isset($k)) {
            $s = $this->keepTag($s, $k, '[{(', '<');
        }

        return trim($s);
    }

    /**
     * @param string $s
     * @param string $openTag
     * @param string $closeTag
     *
     * @return mixed|string
     */
    private function removeElement(string $s, string $openTag, string $closeTag)
    {
        $pos = [];
        $len = [];
        while (stripos($s, $openTag) > 0) {
            $pos[1] = stripos($s, $openTag);
            $pos[2] = stripos($s, $closeTag, $pos[1]);
            $len[1] = $pos[2] - $pos[1] + 1;
            $x = substr($s, $pos[1], $len[1]);
            $s = str_replace($x, '', $s);
        }

        return $s;
    }

    /**
     * @param string $s
     * @param array  $tagToKeep
     * @param string $initial
     * @param string $finalize
     *
     * @return string
     */
    private function keepTag(string $s, array $tagToKeep, string $initial, string $finalize):string
    {
        $count = count($tagToKeep);
        for ($i = 0;$i < $count;++$i) {
            $s = str_replace($initial.$tagToKeep[$i], $finalize.$tagToKeep[$i], $s);
            $s = str_replace($initial.'/'.$tagToKeep[$i], $finalize.'/'.$tagToKeep[$i], $s);
        }

        return $s;
    }
}


1		<?php
2
3		namespace TheCodingMachine\Mail\Template;
4
5		use TheCodingMachine\Mail\SwiftMailTemplate;
6
7		class SwiftTwigMailTemplate implements SwiftMailTemplate
8		{
9		/**
10		* @var \Twig_Environment
11		*/
12		protected $twigEnvironment;
13
14		/**
15		* @var string
16		*/
17		protected $twigPath;
18
19		/**
20		* @var string\|array
21		*/
22		protected $fromAddresses;
23
24		/**
25		* @var string
26		*/
27		protected $fromName = null;
28
29		/**
30		* @var string\|array
31		*/
32		protected $toAddresses;
33
34		/**
35		* @var string
36		*/
37		protected $toName = null;
38
39		/**
40		* @var string\|array
41		*/
42		protected $bccAddresses;
43
44		/**
45		* @var string
46		*/
47		protected $bccName = null;
48
49		/**
50		* @var string\|array
51		*/
52		protected $ccAddresses;
53
54		/**
55		* @var string
56		*/
57		protected $ccName = null;
58
59		/**
60		* @var string\|array
61		*/
62		protected $replyToAddresses;
63
64		/**
65		* @var string
66		*/
67		protected $replyToName = null;
68
69		/**
70		* @var int
71		*/
72		protected $maxLineLength = 1000;
73
74		/**
75		* @var int
76		*/
77		protected $priority;
78
79		/**
80		* @var string
81		*/
82		protected $readReceiptTo;
83
84		/**
85		* @var string
86		*/
87		protected $returnPath;
88
89		/**
90		* SwiftTwigMailGenerator constructor.
91		*
92		* @param \Twig_Environment $twig_Environment
93		* @param string $twigPath
94		*/
95	4	public function __construct(\Twig_Environment $twig_Environment, string $twigPath)
96		{
97	4	$this->twigEnvironment = $twig_Environment;
98	4	$this->twigPath = $twigPath;
99	4	}
100
101		/**
102		* @param array $data
103		*
104		* @return \Swift_Message
105		*/
106	4	public function renderMail(array $data = []) :\Swift_Message
107		{
108	4	$mail = new \Swift_Message();
109
110	4	$twigEnvironment = clone $this->twigEnvironment;
111	4	$function = new \Twig_SimpleFunction('embedImage', function ($imgPath) use ($mail) {
112		return $mail->embed(\Swift_Image::fromPath($imgPath));
113	4	});
114	4	$twigEnvironment->addFunction($function);
115
116	4	$template = $twigEnvironment->loadTemplate($this->twigPath);
117
118	4	if (!$template->hasBlock('subject') \|\| (!$template->hasBlock('body_html') && !$template->hasBlock('body_text'))) {
119	1	throw MissingBlockException::missingBlock($template->getBlockNames());
120		}
121
122	3	$subject = $template->renderBlock('subject', $data);
		0 ignored issues – show Bug introduced 2016-04-27 17:13 UTC by Report Bug Copy Issue Report The method `renderBlock()` does not exist on `Twig_TemplateInterface`. Did you maybe mean `render()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
123	3	$mail->setSubject($subject);
124
125	3	if ($template->hasBlock('body_html')) {
126	2	$bodyHtml = $template->renderBlock('body_html', $data);
		0 ignored issues – show Bug introduced 2016-04-27 17:13 UTC by Report Bug Copy Issue Report The method `renderBlock()` does not exist on `Twig_TemplateInterface`. Did you maybe mean `render()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
127	2	if (!$template->hasBlock('body_text')) {
128	1	$bodyText = $this->removeHtml($bodyHtml);
129		} else {
130	1	$bodyText = $template->renderBlock('body_text', $data);
		0 ignored issues – show Bug introduced 2016-04-27 17:13 UTC by Report Bug Copy Issue Report The method `renderBlock()` does not exist on `Twig_TemplateInterface`. Did you maybe mean `render()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
131		}
132
133	2	$mail->setBody($bodyHtml, 'text/html');
134	2	$mail->addPart($bodyText, 'text/plain');
135		} else {
136	1	$bodyText = $template->renderBlock('body_text', $data);
		0 ignored issues – show Bug introduced 2016-07-25 12:07 UTC by Report Bug Copy Issue Report The method `renderBlock()` does not exist on `Twig_TemplateInterface`. Did you maybe mean `render()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
137
138	1	$mail->setBody($bodyText, 'text/plain');
139		}
140
141		switch (true) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$this->maxLineLength` of type `integer` to the boolean `true`. If you are specifically checking for non-zero, consider using something more explicit like `> 0` or `!== 0` instead. Loading history... Bug Best Practice introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$this->priority` of type `integer` to the boolean `true`. If you are specifically checking for non-zero, consider using something more explicit like `> 0` or `!== 0` instead. Loading history... Bug Best Practice introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$this->readReceiptTo` of type `string` to the boolean `true`. If you are specifically checking for a non-empty string, consider using the more explicit `!== ''` instead. Loading history... Bug Best Practice introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$this->returnPath` of type `string` to the boolean `true`. If you are specifically checking for a non-empty string, consider using the more explicit `!== ''` instead. Loading history...
142	3	case $this->fromAddresses:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
143	1	$mail->setFrom($this->fromAddresses, $this->fromName);
144	1	$mail->setSender($this->fromAddresses, $this->fromName);
145	2	case $this->toAddresses:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
146	1	$mail->setTo($this->toAddresses, $this->toName);
147	2	case $this->bccAddresses:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
148	1	$mail->setBcc($this->bccAddresses, $this->bccName);
149	2	case $this->ccAddresses:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
150	1	$mail->setCc($this->ccAddresses, $this->ccName);
151	2	case $this->replyToAddresses:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
152	1	$mail->setReplyTo($this->replyToAddresses, $this->replyToName);
153	2	case $this->maxLineLength:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
154	3	$mail->setMaxLineLength($this->maxLineLength);
155		case $this->priority:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
156	3	$mail->setPriority($this->priority);
157		case $this->readReceiptTo:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
158	3	$mail->setReadReceiptTo($this->readReceiptTo);
		0 ignored issues – show Documentation introduced 2016-04-27 17:13 UTC by Report Bug Copy Issue Report `$this->readReceiptTo` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
159		case $this->returnPath:
		0 ignored issues – show Coding Style introduced 2016-06-23 17:21 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
160	3	$mail->setReturnPath($this->returnPath);
161		default:
162	3	break;
163		}
164
165	3	return $mail;
166		}
167
168		/**
169		* @param array\|string $fromAddresses
170		*/
171	1	public function setFromAddresses($fromAddresses)
172		{
173	1	$this->fromAddresses = $fromAddresses;
174	1	}
175
176		/**
177		* @param string $fromName
178		*/
179	1	public function setFromName($fromName)
180		{
181	1	$this->fromName = $fromName;
182	1	}
183
184		/**
185		* @param array\|string $toAddresses
186		*/
187	1	public function setToAddresses($toAddresses)
188		{
189	1	$this->toAddresses = $toAddresses;
190	1	}
191
192		/**
193		* @param string $toName
194		*/
195	1	public function setToName($toName)
196		{
197	1	$this->toName = $toName;
198	1	}
199
200		/**
201		* @param array\|string $bccAddresses
202		*/
203	1	public function setBccAddresses($bccAddresses)
204		{
205	1	$this->bccAddresses = $bccAddresses;
206	1	}
207
208		/**
209		* @param string $bccName
210		*/
211	1	public function setBccName($bccName)
212		{
213	1	$this->bccName = $bccName;
214	1	}
215
216		/**
217		* @param array\|string $ccAddresses
218		*/
219	1	public function setCcAddresses($ccAddresses)
220		{
221	1	$this->ccAddresses = $ccAddresses;
222	1	}
223
224		/**
225		* @param string $ccName
226		*/
227	1	public function setCcName($ccName)
228		{
229	1	$this->ccName = $ccName;
230	1	}
231
232		/**
233		* @param array\|string $replyToAddresses
234		*/
235	1	public function setReplyToAddresses($replyToAddresses)
236		{
237	1	$this->replyToAddresses = $replyToAddresses;
238	1	}
239
240		/**
241		* @param string $replyToName
242		*/
243	1	public function setReplyToName($replyToName)
244		{
245	1	$this->replyToName = $replyToName;
246	1	}
247
248		/**
249		* @param int $maxLineLength
250		*/
251	1	public function setMaxLineLength($maxLineLength)
252		{
253	1	$this->maxLineLength = $maxLineLength;
254	1	}
255
256		/**
257		* @param int $priority
258		*/
259	1	public function setPriority($priority)
260		{
261	1	$this->priority = $priority;
262	1	}
263
264		/**
265		* @param string $readReceiptTo
266		*/
267	1	public function setReadReceiptTo($readReceiptTo)
268		{
269	1	$this->readReceiptTo = $readReceiptTo;
270	1	}
271
272		/**
273		* @param string $returnPath
274		*/
275	1	public function setReturnPath($returnPath)
276		{
277	1	$this->returnPath = $returnPath;
278	1	}
279
280		/**
281		* Removes the HTML tags from the text.
282		*
283		* @param string $s
284		* @param string $keep The list of tags to keep
285		* @param string $expand The list of tags to remove completely, along their content
286		*/
287	1	private function removeHtml(string $s, string $keep = '', string $expand = 'script\|style\|noframes\|select\|option') :string
288		{
289		/**///prep the string
290	1	$s = ' '.$s;
291
292		/**///initialize keep tag logic
293	1	if (strlen($keep) > 0) {
294		$k = explode('\|', $keep);
295		$s = $this->keepTag($s, $k, '<', '[{(');
296		}
297		//begin removal
298		/**///remove comment blocks
299	1	$s = $this->removeElement($s, '<!--', '-->');
300
301		/**///remove tags with content between them
302	1	if (strlen($expand) > 0) {
303	1	$e = explode('\|', $expand);
304	1	$count = count($e);
305	1	$pos = [];
306	1	$len = [];
307	1	for ($i = 0;$i < $count;++$i) {
308	1	while (stripos($s, '<'.$e[$i]) > 0) {
309		$len[1] = strlen('<'.$e[$i]);
310		$pos[1] = stripos($s, '<'.$e[$i]);
311		$pos[2] = stripos($s, $e[$i].'>', $pos[1] + $len[1]);
312		$len[2] = $pos[2] - $pos[1] + $len[1];
313		$x = substr($s, $pos[1], $len[2]);
314		$s = str_replace($x, '', $s);
315		}
316		}
317		}
318
319		/**///remove remaining tags
320	1	$s = $this->removeElement($s, '<', '>');
321
322		/**///finalize keep tag
323	1	if (isset($k)) {
324		$s = $this->keepTag($s, $k, '[{(', '<');
325		}
326
327	1	return trim($s);
328		}
329
330		/**
331		* @param string $s
332		* @param string $openTag
333		* @param string $closeTag
334		*
335		* @return mixed\|string
336		*/
337	1	private function removeElement(string $s, string $openTag, string $closeTag)
338		{
339	1	$pos = [];
340	1	$len = [];
341	1	while (stripos($s, $openTag) > 0) {
342	1	$pos[1] = stripos($s, $openTag);
343	1	$pos[2] = stripos($s, $closeTag, $pos[1]);
344	1	$len[1] = $pos[2] - $pos[1] + 1;
345	1	$x = substr($s, $pos[1], $len[1]);
346	1	$s = str_replace($x, '', $s);
347		}
348
349	1	return $s;
350		}
351
352		/**
353		* @param string $s
354		* @param array $tagToKeep
355		* @param string $initial
356		* @param string $finalize
357		*
358		* @return string
359		*/
360		private function keepTag(string $s, array $tagToKeep, string $initial, string $finalize):string
361		{
362		$count = count($tagToKeep);
363		for ($i = 0;$i < $count;++$i) {
364		$s = str_replace($initial.$tagToKeep[$i], $finalize.$tagToKeep[$i], $s);
365		$s = str_replace($initial.'/'.$tagToKeep[$i], $finalize.'/'.$tagToKeep[$i], $s);
366		}
367
368		return $s;
369		}
370		}
371

thecodingmachine / swift-twig-mail-template

Pull Request — 5.0 (#3)

SwiftTwigMailTemplate::setReplyToName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like