Email::setTo() - Code Metrics - jaeger-app/email - Measure and Improve Code Quality continuously with Scrutinizer

Email::setTo() A
last analyzed 2016-07-08 04:45 UTC

↳ Parent: Email

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Jaeger
 *
 * @copyright	Copyright (c) 2015-2016, mithra62
 * @link		http://jaeger-app.com
 * @version		1.0
 * @filesource 	./Email.php
 */
namespace JaegerApp;

use JaegerApp\Exceptions\EmailException;

/**
 * Jaeger - Email Object
 *
 * Wrapper to send email
 *
 * @package Email
 * @author Eric Lamb <[email protected]>
 */
class Email
{

    /**
     * The email addresses we're sending to
     * 
     * @var array
     */
    protected $to = array();

    /**
     * The email subect language key
     * 
     * @var string
     */
    protected $subject = false;

    /**
     * The email message language key
     * 
     * @var string
     */
    protected $message = false;

    /**
     * What type of email to send (html or text)
     * 
     * @var string
     */
    protected $mailtype = 'html';

    /**
     * The mailtype values we allow
     * 
     * @var array
     */
    protected $allowed_mailtypes = array(
        'html',
        'txt'
    );

    /**
     * The View object
     * 
     * @var \JaegerApp\View
     */
    protected $view = null;

    /**
     * The Language object
     * 
     * @var \JaegerApp\Language
     */
    protected $lang = null;

    /**
     * The mailer object
     * 
     * @var Swift_mailer
     */
    protected $mailer = null;

    /**
     * The mailer logging object
     * 
     * @var Swift_Plugins_Loggers_ArrayLogger
     */
    protected $mailer_logger = null;

    /**
     * The email configuration
     * 
     * @var array
     */
    protected $config = array();

    /**
     * The view options
     * 
     * @var array
     */
    protected $view_options = array();

    /**
     * The tmeplate to use for view output
     * 
     * @var string
     */
    protected $view_template = '';

    /**
     * An array of files to add as attachments to emails
     * 
     * @var array A key => value pair of file path => new name
     */
    protected $attachemnts = array();

    /**
     * The format the configuration is expected in
     * 
     * @var array
     */
    private $config_prototype = array(

        'type' => 'smtp', // choose between `php` and `smtp`

        'smtp_options' => array( // if `smtp` chosen above, this must be completed and accurate
            'host' => '',
            'connection_config' => array(
                'username' => '',
                'password' => ''
            ),
            'port' => ''
        )
    );

    /**
     * Sets the Language object
     * 
     * @param \JaegerApp\Language $lang            
     * @return \JaegerApp\Email
     */
    public function setLang(\JaegerApp\Language $lang)
    {
        $this->lang = $lang;
        return $this;
    }

    /**
     * Returns an instance of the Language object
     * 
     * @return \JaegerApp\Language
     */
    public function getLang()
    {
        return $this->lang;
    }

    /**
     * Sets the View object
     * 
     * @param \JaegerApp\View $view            
     * @return \JaegerApp\Email
     */
    public function setView(\JaegerApp\View $view)
    {
        $this->view = $view;
        return $this;
    }

    /**
     * Returns an instance of the View object
     * 
     * @return \JaegerApp\View
     */
    public function getView()
    {
        return $this->view;
    }

    /**
     * Sets the email config
     * 
     * @param array $config            
     * @return \JaegerApp\Email
     */
    public function setConfig(array $config)
    {
        $this->config = $config;
        return $this;
    }

    /**
     * Compiles the options to use for the view
     * 
     * @param string $template            
     * @param array $view_data            
     * @return \JaegerApp\Email
     */
    public function setViewOptions($template, array $view_data = array())
    {
        $this->view_options = $view_data;
        $this->view_template = $template;
        return $this;
    }

    /**
     * Sets the TO email address
     *
     * Note that this method resets any previously added email addresses
     * 
     * @param string $to            
     * @return \JaegerApp\Email
     */
    public function setTo($to)
    {
        $this->to = (is_array($to) ? $to : array(
            $to
        ));
        return $this;
    }

    /**
     * Sets the email addresses to send to
     * 
     * @param string $to
     *            The Email address to send to
     * @return \JaegerApp\Email
     */
    public function addTo($to)
    {
        $this->to[] = $to;
        return $this;
    }

    /**
     * Adds an attachment to an email
     * 
     * @param string $file
     *            The full path to the attachment
     * @param string $name
     *            An alternative name to use for the attachment file
     */
    public function addAttachment($file, $name = false)
    {
        if (file_exists($file)) {
            $this->attachemnts[] = array(
                $file => $name
            );
        }
        
        return $this;
    }

    /**
     * Returns an array of attachments
     * 
     * @return string
     */
    public function getAttachments()
    {
        return $this->attachemnts;
    }

    /**
     * Returns the email addresses to send to
     */
    public function getTo()
    {
        return $this->to;
    }

    /**
     * Sets the email subject language key
     * 
     * @param string $subject
     *            The language key for the email subject
     */
    public function setSubject($subject)
    {
        $this->subject = $subject;
        return $this;
    }

    /**
     * Returns the email addresses to send to
     */
    public function getSubject()
    {
        return $this->subject;
    }

    /**
     * Returns the message language key
     * 
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Set the email message language key
     * 
     * @param string $message
     *            Should be a language file key
     * @return \JaegerApp\Email
     */
    public function setMessage($message)
    {
        $this->message = $message;
        return $this;
    }

    /**
     * Returns the mailtype
     * 
     * @return string
     */
    public function getMailtype()
    {
        return $this->mailtype;
    }

    /**
     * Sets the mailtype
     * 
     * @param string $mailtype            
     * @return \JaegerApp\Email
     */
    public function setMailtype($mailtype)
    {
        $this->mailtype = $mailtype;
        return $this;
    }

    /**
     * Returns an instance of the mail object
     * 
     * @return Email\SwiftAbstract
     */
    public function getMailer()
    {
        if (is_null($this->mailer)) {
            if(class_exists('\Swift'))
            {
                if(version_compare(\Swift::VERSION, 4, '<=') && version_compare(\Swift::VERSION, 3, '>='))
                {
                    $mailer = new Email\Swift3($this->config);
                }
                else {
                    $mailer = new Email\Swift5($this->config);
                }
            }
            else {
                $mailer = new Email\Swift5($this->config); 
            }
            
            $this->mailer = $mailer;

        }
        
        return $this->mailer;
    }

    /**
     * Resets the email object
     * 
     * @return \JaegerApp\Email
     */
    public function clear()
    {
        $this->mailer = null;
        $this->to = $this->attachemnts = array();
        $this->subject = $this->message = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        return $this;
    }

    /**
     * Sends the email
     * 
     * @param array $vars            
     * @throws \InvalidArgumentException
     * @throws \InvalidArgumentException
     * @throws EmailException
     */
    public function send(array $vars = array())
    {
        if (count($this->getTo()) == 0) {
            throw new \InvalidArgumentException('A "To" email address is requried');
        }
        
        if ($this->getSubject() == '') {
            throw new \InvalidArgumentException('A subject for the email must be set');
        }
        
        if ($this->getMessage() == '') {
            throw new \InvalidArgumentException('There isn\'t a message set');
        }
        
        $valid_emails = array();
        foreach ($this->getTo() as $to) {
            if (filter_var(trim($to), FILTER_VALIDATE_EMAIL)) {
                $valid_emails[] = trim($to);
            }
        }
        
        if (! $valid_emails) {

            return;
        }
        
        $mailer = $this->getMailer();
        $subject = $this->getView()->render($this->getSubject(), $vars);
        $body_message = $this->getView()->render($this->getMessage(), $vars);
        $message = $mailer->getMessage($valid_emails, $this->config['from_email'], $this->config['sender_name'], $subject, $body_message, $this->getAttachments(), $this->getMailtype());
        
        if (! $mailer->send($message)) {
            throw new EmailException($this->getMailer()->ErrorInfo);
        }
        
        $this->clear();
    }
}

1			<?php
2			/**
3			* Jaeger
4			*
5			* @copyright Copyright (c) 2015-2016, mithra62
6			* @link http://jaeger-app.com
7			* @version 1.0
8			* @filesource ./Email.php
9			*/
10			namespace JaegerApp;
11
12			use JaegerApp\Exceptions\EmailException;
13
14			/**
15			* Jaeger - Email Object
16			*
17			* Wrapper to send email
18			*
19			* @package Email
20			* @author Eric Lamb <[email protected]>
21			*/
22			class Email
23			{
24
25			/**
26			* The email addresses we're sending to
27			*
28			* @var array
29			*/
30			protected $to = array();
31
32			/**
33			* The email subect language key
34			*
35			* @var string
36			*/
37			protected $subject = false;
38
39			/**
40			* The email message language key
41			*
42			* @var string
43			*/
44			protected $message = false;
45
46			/**
47			* What type of email to send (html or text)
48			*
49			* @var string
50			*/
51			protected $mailtype = 'html';
52
53			/**
54			* The mailtype values we allow
55			*
56			* @var array
57			*/
58			protected $allowed_mailtypes = array(
59			'html',
60			'txt'
61			);
62
63			/**
64			* The View object
65			*
66			* @var \JaegerApp\View
67			*/
68			protected $view = null;
69
70			/**
71			* The Language object
72			*
73			* @var \JaegerApp\Language
74			*/
75			protected $lang = null;
76
77			/**
78			* The mailer object
79			*
80			* @var Swift_mailer
81			*/
82			protected $mailer = null;
83
84			/**
85			* The mailer logging object
86			*
87			* @var Swift_Plugins_Loggers_ArrayLogger
88			*/
89			protected $mailer_logger = null;
90
91			/**
92			* The email configuration
93			*
94			* @var array
95			*/
96			protected $config = array();
97
98			/**
99			* The view options
100			*
101			* @var array
102			*/
103			protected $view_options = array();
104
105			/**
106			* The tmeplate to use for view output
107			*
108			* @var string
109			*/
110			protected $view_template = '';
111
112			/**
113			* An array of files to add as attachments to emails
114			*
115			* @var array A key => value pair of file path => new name
116			*/
117			protected $attachemnts = array();
118
119			/**
120			* The format the configuration is expected in
121			*
122			* @var array
123			*/
124			private $config_prototype = array(
			0 ignored issues – show Unused Code introduced 2016-04-19 02:44 UTC by Report Bug Copy Issue Report The property `$config_prototype` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
125			'type' => 'smtp', // choose between `php` and `smtp`
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-19 02:44 UTC by Report Bug Copy Issue Report `36%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
126			'smtp_options' => array( // if `smtp` chosen above, this must be completed and accurate
127			'host' => '',
128			'connection_config' => array(
129			'username' => '',
130			'password' => ''
131			),
132			'port' => ''
133			)
134			);
135
136			/**
137			* Sets the Language object
138			*
139			* @param \JaegerApp\Language $lang
140			* @return \JaegerApp\Email
141			*/
142			public function setLang(\JaegerApp\Language $lang)
143			{
144			$this->lang = $lang;
145			return $this;
146			}
147
148			/**
149			* Returns an instance of the Language object
150			*
151			* @return \JaegerApp\Language
152			*/
153			public function getLang()
154			{
155			return $this->lang;
156			}
157
158			/**
159			* Sets the View object
160			*
161			* @param \JaegerApp\View $view
162			* @return \JaegerApp\Email
163			*/
164			public function setView(\JaegerApp\View $view)
165			{
166			$this->view = $view;
167			return $this;
168			}
169
170			/**
171			* Returns an instance of the View object
172			*
173			* @return \JaegerApp\View
174			*/
175			public function getView()
176			{
177			return $this->view;
178			}
179
180			/**
181			* Sets the email config
182			*
183			* @param array $config
184			* @return \JaegerApp\Email
185			*/
186			public function setConfig(array $config)
187			{
188			$this->config = $config;
189			return $this;
190			}
191
192			/**
193			* Compiles the options to use for the view
194			*
195			* @param string $template
196			* @param array $view_data
197			* @return \JaegerApp\Email
198			*/
199			public function setViewOptions($template, array $view_data = array())
200			{
201			$this->view_options = $view_data;
202			$this->view_template = $template;
203			return $this;
204			}
205
206			/**
207			* Sets the TO email address
208			*
209			* Note that this method resets any previously added email addresses
210			*
211			* @param string $to
212			* @return \JaegerApp\Email
213			*/
214			public function setTo($to)
215			{
216			$this->to = (is_array($to) ? $to : array(
217			$to
218			));
219			return $this;
220			}
221
222			/**
223			* Sets the email addresses to send to
224			*
225			* @param string $to
226			* The Email address to send to
227			* @return \JaegerApp\Email
228			*/
229			public function addTo($to)
230			{
231			$this->to[] = $to;
232			return $this;
233			}
234
235			/**
236			* Adds an attachment to an email
237			*
238			* @param string $file
239			* The full path to the attachment
240			* @param string $name
241			* An alternative name to use for the attachment file
242			*/
243			public function addAttachment($file, $name = false)
244			{
245			if (file_exists($file)) {
246			$this->attachemnts[] = array(
247			$file => $name
248			);
249			}
250
251			return $this;
252			}
253
254			/**
255			* Returns an array of attachments
256			*
257			* @return string
258			*/
259			public function getAttachments()
260			{
261			return $this->attachemnts;
262			}
263
264			/**
265			* Returns the email addresses to send to
266			*/
267			public function getTo()
268			{
269			return $this->to;
270			}
271
272			/**
273			* Sets the email subject language key
274			*
275			* @param string $subject
276			* The language key for the email subject
277			*/
278			public function setSubject($subject)
279			{
280			$this->subject = $subject;
281			return $this;
282			}
283
284			/**
285			* Returns the email addresses to send to
286			*/
287			public function getSubject()
288			{
289			return $this->subject;
290			}
291
292			/**
293			* Returns the message language key
294			*
295			* @return string
296			*/
297			public function getMessage()
298			{
299			return $this->message;
300			}
301
302			/**
303			* Set the email message language key
304			*
305			* @param string $message
306			* Should be a language file key
307			* @return \JaegerApp\Email
308			*/
309			public function setMessage($message)
310			{
311			$this->message = $message;
312			return $this;
313			}
314
315			/**
316			* Returns the mailtype
317			*
318			* @return string
319			*/
320			public function getMailtype()
321			{
322			return $this->mailtype;
323			}
324
325			/**
326			* Sets the mailtype
327			*
328			* @param string $mailtype
329			* @return \JaegerApp\Email
330			*/
331			public function setMailtype($mailtype)
332			{
333			$this->mailtype = $mailtype;
334			return $this;
335			}
336
337			/**
338			* Returns an instance of the mail object
339			*
340			* @return Email\SwiftAbstract
341			*/
342			public function getMailer()
343			{
344			if (is_null($this->mailer)) {
345			if(class_exists('\Swift'))
346			{
347			if(version_compare(\Swift::VERSION, 4, '<=') && version_compare(\Swift::VERSION, 3, '>='))
348			{
349			$mailer = new Email\Swift3($this->config);
350			}
351			else {
352			$mailer = new Email\Swift5($this->config);
353			}
354			}
355			else {
356			$mailer = new Email\Swift5($this->config);
357			}
358
359			$this->mailer = $mailer;
			0 ignored issues – show Documentation Bug introduced 2016-04-19 02:44 UTC by Report Bug Copy Issue Report It seems like `$mailer` of type `object<JaegerApp\Email\Swift3>` or `object<JaegerApp\Email\Swift5>` is incompatible with the declared type `object<JaegerApp\Swift_mailer>` of property `$mailer`. 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...
360			}
361
362			return $this->mailer;
363			}
364
365			/**
366			* Resets the email object
367			*
368			* @return \JaegerApp\Email
369			*/
370			public function clear()
371			{
372			$this->mailer = null;
373			$this->to = $this->attachemnts = array();
374			$this->subject = $this->message = false;
			0 ignored issues – show Documentation Bug introduced 2016-04-19 02:44 UTC by Report Bug Copy Issue Report The property `$message` was declared of type `string`, but `false` is of type `false`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history... Documentation Bug introduced 2016-04-19 02:44 UTC by Report Bug Copy Issue Report The property `$subject` was declared of type `string`, but `$this->message = false` is of type `false`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
375			return $this;
376			}
377
378			/**
379			* Sends the email
380			*
381			* @param array $vars
382			* @throws \InvalidArgumentException
383			* @throws \InvalidArgumentException
384			* @throws EmailException
385			*/
386			public function send(array $vars = array())
387			{
388			if (count($this->getTo()) == 0) {
389			throw new \InvalidArgumentException('A "To" email address is requried');
390			}
391
392			if ($this->getSubject() == '') {
393			throw new \InvalidArgumentException('A subject for the email must be set');
394			}
395
396			if ($this->getMessage() == '') {
397			throw new \InvalidArgumentException('There isn\'t a message set');
398			}
399
400			$valid_emails = array();
401			foreach ($this->getTo() as $to) {
402			if (filter_var(trim($to), FILTER_VALIDATE_EMAIL)) {
403			$valid_emails[] = trim($to);
404			}
405			}
406
407			if (! $valid_emails) {
			0 ignored issues – show Bug Best Practice introduced 2016-04-19 02:44 UTC by Report Bug Copy Issue Report The expression `$valid_emails` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
408			return;
409			}
410
411			$mailer = $this->getMailer();
412			$subject = $this->getView()->render($this->getSubject(), $vars);
413			$body_message = $this->getView()->render($this->getMessage(), $vars);
414			$message = $mailer->getMessage($valid_emails, $this->config['from_email'], $this->config['sender_name'], $subject, $body_message, $this->getAttachments(), $this->getMailtype());
415
416			if (! $mailer->send($message)) {
417			throw new EmailException($this->getMailer()->ErrorInfo);
418			}
419
420			$this->clear();
421			}
422			}

jaeger-app / email

Email::setTo() A last analyzed 2016-07-08 04:45 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Email::setTo() A
last analyzed 2016-07-08 04:45 UTC