SwiftTwigMailTemplate::__construct() - Code Metrics - Inspection of "Add ReadMe.md and make the text body optional" - thecodingmachine/swift-twig-mail-template - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 5.0 (#1)

by Huberty

created 2016-06-01 15:49 UTC

SwiftTwigMailTemplate::__construct() A

↳ Parent: SwiftTwigMailTemplate

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?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')) {
            throw MissingBlockException::missingBlock($template->getBlockNames());
        }

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

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

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


        }

        $mail->setSubject($subject);
        $mail->setBody($bodyHtml);
        $mail->addPart($bodyText);

        if ($this->fromAddresses) {
            $mail->setFrom($this->fromAddresses, $this->fromName);
            $mail->setSender($this->fromAddresses, $this->fromName);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        if ($this->toAddresses) {
            $mail->setTo($this->toAddresses, $this->toName);
        }

        if ($this->bccAddresses) {
            $mail->setBcc($this->bccAddresses, $this->bccName);
        }
        if ($this->ccAddresses) {
            $mail->setCc($this->ccAddresses, $this->ccName);
        }
        if ($this->replyToAddresses) {
            $mail->setReplyTo($this->replyToAddresses, $this->replyToName);
        }

        if ($this->maxLineLength) {
            $mail->setMaxLineLength($this->maxLineLength);
        }
        if ($this->priority) {
            $mail->setPriority($this->priority);
        }

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

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        if ($this->returnPath) {
            $mail->setReturnPath($this->returnPath);
        }

        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);
            for($i=0;$i<count($k);$i++){
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $s = str_replace('<' . $k[$i],'[{(' . $k[$i],$s);
                $s = str_replace('</' . $k[$i],'[{(/' . $k[$i],$s);
            }
        }
        $pos = array();
        $len = array();

        //begin removal
        /**///remove comment blocks
        while(stripos($s,'<!--') > 0){

            $pos[1] = stripos($s,'<!--');
            $pos[2] = stripos($s,'-->', $pos[1]);
            $len[1] = $pos[2] - $pos[1] + 3;
            $x = substr($s,$pos[1],$len[1]);
            $s = str_replace($x,'',$s);
        }

        /**///remove tags with content between them
        if(strlen($expand) > 0){
            $e = explode('|',$expand);
            for($i=0;$i<count($e);$i++){
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                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
        while(stripos($s,'<') > 0){

            $pos[1] = stripos($s,'<');
            $pos[2] = stripos($s,'>', $pos[1]);
            $len[1] = $pos[2] - $pos[1] + 1;
            $x = substr($s,$pos[1],$len[1]);
            $s = str_replace($x,'',$s);
        }

        /**///finalize keep tag
        if (isset($k)) {
            for($i=0;$i<count($k);$i++){
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $s = str_replace('[{(' . $k[$i],'<' . $k[$i],$s);
                $s = str_replace('[{(/' . $k[$i],'</' . $k[$i],$s);
            }
        }

        return trim($s);
    }
}


1		<?php
2
3		namespace TheCodingMachine\Mail\Template;
4
5
6		use TheCodingMachine\Mail\SwiftMailTemplate;
7
8		class SwiftTwigMailTemplate implements SwiftMailTemplate
9		{
10		/**
11		* @var \Twig_Environment
12		*/
13		protected $twigEnvironment;
14
15		/**
16		* @var string
17		*/
18		protected $twigPath;
19
20		/**
21		* @var string\|array
22		*/
23		protected $fromAddresses;
24
25		/**
26		* @var string
27		*/
28		protected $fromName = null;
29
30		/**
31		* @var string\|array
32		*/
33		protected $toAddresses;
34
35		/**
36		* @var string
37		*/
38		protected $toName = null;
39
40		/**
41		* @var string\|array
42		*/
43		protected $bccAddresses;
44
45		/**
46		* @var string
47		*/
48		protected $bccName = null;
49
50		/**
51		* @var string\|array
52		*/
53		protected $ccAddresses;
54
55		/**
56		* @var string
57		*/
58		protected $ccName = null;
59
60		/**
61		* @var string\|array
62		*/
63		protected $replyToAddresses;
64
65		/**
66		* @var string
67		*/
68		protected $replyToName = null;
69
70		/**
71		* @var int
72		*/
73		protected $maxLineLength = 1000;
74
75		/**
76		* @var int
77		*/
78		protected $priority;
79
80		/**
81		* @var string
82		*/
83		protected $readReceiptTo;
84
85		/**
86		* @var string
87		*/
88		protected $returnPath;
89
90		/**
91		* SwiftTwigMailGenerator constructor.
92		*
93		* @param \Twig_Environment $twig_Environment
94		* @param string $twigPath
95		*/
96		public function __construct(\Twig_Environment $twig_Environment, string $twigPath)
97		{
98		$this->twigEnvironment = $twig_Environment;
99		$this->twigPath = $twigPath;
100		}
101
102		/**
103		* @param array $data
104		*
105		* @return \Swift_Message
106		*/
107		public function renderMail(array $data = []) :\Swift_Message
108		{
109		$mail = new \Swift_Message();
110
111		$twigEnvironment = clone $this->twigEnvironment;
112		$function = new \Twig_SimpleFunction('embedImage', function ($imgPath) use ($mail) {
113		return $mail->embed(\Swift_Image::fromPath($imgPath));
114		});
115		$twigEnvironment->addFunction($function);
116
117		$template = $twigEnvironment->loadTemplate($this->twigPath);
118
119		if (!$template->hasBlock('subject') \|\| !$template->hasBlock('body_html')) {
120		throw MissingBlockException::missingBlock($template->getBlockNames());
121		}
122
123		$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...
124		$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...
125		if (!$template->hasBlock('body_text')) {
126		$bodyText = $this->removeHtml($bodyHtml);
127		} else {
128		$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...
129
130		}
131
132		$mail->setSubject($subject);
133		$mail->setBody($bodyHtml);
134		$mail->addPart($bodyText);
135
136		if ($this->fromAddresses) {
137		$mail->setFrom($this->fromAddresses, $this->fromName);
138		$mail->setSender($this->fromAddresses, $this->fromName);
		1 ignored issue – show Bug introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report It seems like `$this->fromAddresses` can also be of type `array`; however, `Swift_Mime_SimpleMessage::setSender()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
139		}
140
141		if ($this->toAddresses) {
142		$mail->setTo($this->toAddresses, $this->toName);
143		}
144
145		if ($this->bccAddresses) {
146		$mail->setBcc($this->bccAddresses, $this->bccName);
147		}
148		if ($this->ccAddresses) {
149		$mail->setCc($this->ccAddresses, $this->ccName);
150		}
151		if ($this->replyToAddresses) {
152		$mail->setReplyTo($this->replyToAddresses, $this->replyToName);
153		}
154
155		if ($this->maxLineLength) {
156		$mail->setMaxLineLength($this->maxLineLength);
157		}
158		if ($this->priority) {
159		$mail->setPriority($this->priority);
160		}
161
162		if ($this->readReceiptTo) {
163		$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...
164		}
165
166		if ($this->returnPath) {
167		$mail->setReturnPath($this->returnPath);
168		}
169
170		return $mail;
171		}
172
173		/**
174		* @param array\|string $fromAddresses
175		*/
176		public function setFromAddresses($fromAddresses)
177		{
178		$this->fromAddresses = $fromAddresses;
179		}
180
181		/**
182		* @param string $fromName
183		*/
184		public function setFromName($fromName)
185		{
186		$this->fromName = $fromName;
187		}
188
189		/**
190		* @param array\|string $toAddresses
191		*/
192		public function setToAddresses($toAddresses)
193		{
194		$this->toAddresses = $toAddresses;
195		}
196
197		/**
198		* @param string $toName
199		*/
200		public function setToName($toName)
201		{
202		$this->toName = $toName;
203		}
204
205		/**
206		* @param array\|string $bccAddresses
207		*/
208		public function setBccAddresses($bccAddresses)
209		{
210		$this->bccAddresses = $bccAddresses;
211		}
212
213		/**
214		* @param string $bccName
215		*/
216		public function setBccName($bccName)
217		{
218		$this->bccName = $bccName;
219		}
220
221		/**
222		* @param array\|string $ccAddresses
223		*/
224		public function setCcAddresses($ccAddresses)
225		{
226		$this->ccAddresses = $ccAddresses;
227		}
228
229		/**
230		* @param string $ccName
231		*/
232		public function setCcName($ccName)
233		{
234		$this->ccName = $ccName;
235		}
236
237		/**
238		* @param array\|string $replyToAddresses
239		*/
240		public function setReplyToAddresses($replyToAddresses)
241		{
242		$this->replyToAddresses = $replyToAddresses;
243		}
244
245		/**
246		* @param string $replyToName
247		*/
248		public function setReplyToName($replyToName)
249		{
250		$this->replyToName = $replyToName;
251		}
252
253		/**
254		* @param int $maxLineLength
255		*/
256		public function setMaxLineLength($maxLineLength)
257		{
258		$this->maxLineLength = $maxLineLength;
259		}
260
261		/**
262		* @param int $priority
263		*/
264		public function setPriority($priority)
265		{
266		$this->priority = $priority;
267		}
268
269		/**
270		* @param string $readReceiptTo
271		*/
272		public function setReadReceiptTo($readReceiptTo)
273		{
274		$this->readReceiptTo = $readReceiptTo;
275		}
276
277		/**
278		* @param string $returnPath
279		*/
280		public function setReturnPath($returnPath)
281		{
282		$this->returnPath = $returnPath;
283		}
284
285		/**
286		* Removes the HTML tags from the text.
287		*
288		* @param string $s
289		* @param string $keep The list of tags to keep
290		* @param string $expand The list of tags to remove completely, along their content
291		*/
292		private function removeHtml(string $s , string $keep = '' , string $expand = 'script\|style\|noframes\|select\|option') :string
293		{
294		/**///prep the string
295		$s = ' ' . $s;
296
297		/**///initialize keep tag logic
298		if(strlen($keep) > 0){
299		$k = explode('\|',$keep);
300	View Code Duplication	for($i=0;$i<count($k);$i++){
		0 ignored issues – show Performance Best Practice introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history... Duplication introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
301		$s = str_replace('<' . $k[$i],'[{(' . $k[$i],$s);
302		$s = str_replace('</' . $k[$i],'[{(/' . $k[$i],$s);
303		}
304		}
305		$pos = array();
306		$len = array();
307
308		//begin removal
309		/**///remove comment blocks
310	View Code Duplication	while(stripos($s,'<!--') > 0){
		0 ignored issues – show Duplication introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
311		$pos[1] = stripos($s,'<!--');
312		$pos[2] = stripos($s,'-->', $pos[1]);
313		$len[1] = $pos[2] - $pos[1] + 3;
314		$x = substr($s,$pos[1],$len[1]);
315		$s = str_replace($x,'',$s);
316		}
317
318		/**///remove tags with content between them
319		if(strlen($expand) > 0){
320		$e = explode('\|',$expand);
321		for($i=0;$i<count($e);$i++){
		0 ignored issues – show Performance Best Practice introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
322		while(stripos($s,'<' . $e[$i]) > 0){
323		$len[1] = strlen('<' . $e[$i]);
324		$pos[1] = stripos($s,'<' . $e[$i]);
325		$pos[2] = stripos($s,$e[$i] . '>', $pos[1] + $len[1]);
326		$len[2] = $pos[2] - $pos[1] + $len[1];
327		$x = substr($s,$pos[1],$len[2]);
328		$s = str_replace($x,'',$s);
329		}
330		}
331		}
332
333		/**///remove remaining tags
334	View Code Duplication	while(stripos($s,'<') > 0){
		0 ignored issues – show Duplication introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
335		$pos[1] = stripos($s,'<');
336		$pos[2] = stripos($s,'>', $pos[1]);
337		$len[1] = $pos[2] - $pos[1] + 1;
338		$x = substr($s,$pos[1],$len[1]);
339		$s = str_replace($x,'',$s);
340		}
341
342		/**///finalize keep tag
343		if (isset($k)) {
344	View Code Duplication	for($i=0;$i<count($k);$i++){
		0 ignored issues – show Performance Best Practice introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history... Duplication introduced 2016-06-01 15:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
345		$s = str_replace('[{(' . $k[$i],'<' . $k[$i],$s);
346		$s = str_replace('[{(/' . $k[$i],'</' . $k[$i],$s);
347		}
348		}
349
350		return trim($s);
351		}
352		}
353

thecodingmachine / swift-twig-mail-template

Pull Request — 5.0 (#1)

SwiftTwigMailTemplate::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like