Mail::contactform() - Code Metrics - Inspection of "Merge pull request #2667 from mecab/remove-validat..." - MPOS/php-mpos - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( 6dab6b...1d32e1 )

by Sebastian

created 2018-02-01 08:51 UTC

Mail::contactform() B

↳ Parent: Mail

Complexity

Conditions	5
Paths	4

Size

Total Lines	24
Code Lines	20

Duplication

Lines	5
Ratio	20.83 %

Importance

Changes

Metric	Value
dl	5
loc	24
rs	8.5125
c	0
b	0
f	0
cc	5
eloc	20
nc	4
nop	4

<?php

(!cfip()) ? header('HTTP/1.1 401 Unauthorized') : 0;

class Mail extends Base {
namespace YourVendor;

class YourClass { }
  /**
  * Mail form contact site admin
  * @param senderName string senderName
  * @param senderEmail string senderEmail
  * @param senderSubject string senderSubject
  * @param senderMessage string senderMessage
  * @param email string config Email address
  * @param subject string header subject
  * @return bool
  **/
  public function contactform($senderName, $senderEmail, $senderSubject, $senderMessage) {
    $this->debug->append("STA " . __METHOD__, 4);
    if (empty($senderEmail) || !filter_var($senderEmail, FILTER_VALIDATE_EMAIL)) {

      $this->setErrorMessage($this->getErrorMsg('E0023'));
      return false;
    }
    if (strlen(strip_tags($senderMessage)) < strlen($senderMessage)) {
      $this->setErrorMessage($this->getErrorMsg('E0024'));
      return false;
    }
    $aData['senderName'] = $senderName;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
    $aData['senderEmail'] = $senderEmail;
    $aData['senderSubject'] = $senderSubject;
    $aData['senderMessage'] = $senderMessage;
    $aData['email'] = $this->setting->getValue('website_email', '[email protected]');
class MyClass { }

$x = new MyClass();
$x->foo = true;
    $aData['subject'] = 'Contact Form';
      if ($this->sendMail('contactform/body', $aData)) {
        return true;
     } else {
       $this->setErrorMessage( 'Unable to send email' );
       return false;
     }
    return false;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
  }

  /**
   * Send a mail with templating via Smarty and Siftmailer
   * @param template string Template name within the mail folder, no extension
   * @param aData array Data array with some required fields
   *     subject : Mail Subject
   *     email   : Destination address
   **/
  public function sendMail($template, $aData, $throttle=false) {
    // Prepare SMTP transport and mailer
    $transport_type = $this->config['swiftmailer']['type'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
    if ($transport_type == 'sendmail') {
      $transport = Swift_SendmailTransport::newInstance($this->config['swiftmailer'][$transport_type]['path'] . ' ' . $this->config['swiftmailer'][$transport_type]['options']);
    } else if ($this->config['swiftmailer']['type'] == 'smtp') {
      $transport = Swift_SmtpTransport::newInstance($this->config['swiftmailer']['smtp']['host'], $this->config['swiftmailer']['smtp']['port'], $this->config['swiftmailer']['smtp']['encryption']);
      if (!empty($this->config['swiftmailer']['smtp']['username']) && !empty($this->config['swiftmailer']['smtp']['password'])) {
        $transport->setUsername($this->config['swiftmailer']['smtp']['username']);
        $transport->setPassword($this->config['swiftmailer']['smtp']['password']);
      }
    }
    $mailer = Swift_Mailer::newInstance($transport);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

    // Throttle mails to x per minute, used for newsletter for example
    if ($this->config['swiftmailer']['type'] == 'smtp' && $throttle) {
      $mailer->registerPlugin(new Swift_Plugins_ThrottlerPlugin(
        $this->config['swiftmailer']['smtp']['throttle'], Swift_Plugins_ThrottlerPlugin::MESSAGES_PER_MINUTE
      ));
    }

    // Prepare the smarty templates used
    $this->smarty->clearCache(TEMPLATE_DIR . '/mail/' . $template . '.tpl');
    $this->smarty->clearCache(TEMPLATE_DIR . '/mail/subject.tpl');
    $this->smarty->assign('WEBSITENAME', $this->setting->getValue('website_name'));
    $this->smarty->assign('SUBJECT', $aData['subject']);
    $this->smarty->assign('DATA', $aData);

    // Create new message for Swiftmailer
    $senderEmail = $this->setting->getValue('website_email', '[email protected]');
    $senderName = $this->setting->getValue('website_name', '[email protected]');
    $message = Swift_Message::newInstance()
      ->setSubject($this->smarty->fetch(TEMPLATE_DIR . '/mail/subject.tpl'))
      ->setFrom(array( $senderEmail => $senderName))
      ->setTo($aData['email'])
      ->setSender($senderEmail)
      ->setReturnPath($senderEmail)
      ->setBody($this->smarty->fetch(TEMPLATE_DIR . '/mail/' . $template . '.tpl'), 'text/html');
    if (isset($aData['senderName']) &&
        isset($aData['senderEmail']) &&
        strlen($aData['senderName']) > 0 &&
        strlen($aData['senderEmail']) > 0 &&
        filter_var($aData['senderEmail'], FILTER_VALIDATE_EMAIL))
      $message->setReplyTo(array($aData['senderEmail'] => $aData['senderName']));

    // Send message out with configured transport
    try {
      if ($mailer->send($message)) return true;
    } catch (Exception $e) {
      $this->setErrorMessage($e->getMessage());
      return false;
    }
    $this->setErrorMessage($this->sqlError('E0031'));
    return false;
  }
}

// Make our class available automatically
$mail = new Mail ();
$mail->setDebug($debug);
$mail->setMysql($mysqli);
$mail->setSmarty($smarty);
$mail->setConfig($config);
$mail->setSetting($setting);
$mail->setErrorCodes($aErrorCodes);


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-22 07:52 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 4 and the first side effect is on line 2. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		(!cfip()) ? header('HTTP/1.1 401 Unauthorized') : 0;
3
4		class Mail extends Base {
		0 ignored issues – show Coding Style Compatibility introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
5		/**
6		* Mail form contact site admin
7		* @param senderName string senderName
8		* @param senderEmail string senderEmail
9		* @param senderSubject string senderSubject
10		* @param senderMessage string senderMessage
11		* @param email string config Email address
12		* @param subject string header subject
13		* @return bool
14		**/
15		public function contactform($senderName, $senderEmail, $senderSubject, $senderMessage) {
16		$this->debug->append("STA " . __METHOD__, 4);
17	View Code Duplication	if (empty($senderEmail) \|\| !filter_var($senderEmail, FILTER_VALIDATE_EMAIL)) {
		0 ignored issues – show Duplication introduced 2015-12-09 12:23 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...
18		$this->setErrorMessage($this->getErrorMsg('E0023'));
19		return false;
20		}
21		if (strlen(strip_tags($senderMessage)) < strlen($senderMessage)) {
22		$this->setErrorMessage($this->getErrorMsg('E0024'));
23		return false;
24		}
25		$aData['senderName'] = $senderName;
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report `$aData` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$aData = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
26		$aData['senderEmail'] = $senderEmail;
27		$aData['senderSubject'] = $senderSubject;
28		$aData['senderMessage'] = $senderMessage;
29		$aData['email'] = $this->setting->getValue('website_email', '[email protected]');
		0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The property `setting` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
30		$aData['subject'] = 'Contact Form';
31		if ($this->sendMail('contactform/body', $aData)) {
32		return true;
33		} else {
34		$this->setErrorMessage( 'Unable to send email' );
35		return false;
36		}
37		return false;
		0 ignored issues – show Unused Code introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report `return false;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
38		}
39
40		/**
41		* Send a mail with templating via Smarty and Siftmailer
42		* @param template string Template name within the mail folder, no extension
43		* @param aData array Data array with some required fields
44		* subject : Mail Subject
45		* email : Destination address
46		**/
47		public function sendMail($template, $aData, $throttle=false) {
48		// Prepare SMTP transport and mailer
49		$transport_type = $this->config['swiftmailer']['type'];
		0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The property `config` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
50		if ($transport_type == 'sendmail') {
51		$transport = Swift_SendmailTransport::newInstance($this->config['swiftmailer'][$transport_type]['path'] . ' ' . $this->config['swiftmailer'][$transport_type]['options']);
52		} else if ($this->config['swiftmailer']['type'] == 'smtp') {
53		$transport = Swift_SmtpTransport::newInstance($this->config['swiftmailer']['smtp']['host'], $this->config['swiftmailer']['smtp']['port'], $this->config['swiftmailer']['smtp']['encryption']);
54		if (!empty($this->config['swiftmailer']['smtp']['username']) && !empty($this->config['swiftmailer']['smtp']['password'])) {
55		$transport->setUsername($this->config['swiftmailer']['smtp']['username']);
56		$transport->setPassword($this->config['swiftmailer']['smtp']['password']);
57		}
58		}
59		$mailer = Swift_Mailer::newInstance($transport);
		0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The variable `$transport` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
60
61		// Throttle mails to x per minute, used for newsletter for example
62		if ($this->config['swiftmailer']['type'] == 'smtp' && $throttle) {
63		$mailer->registerPlugin(new Swift_Plugins_ThrottlerPlugin(
64		$this->config['swiftmailer']['smtp']['throttle'], Swift_Plugins_ThrottlerPlugin::MESSAGES_PER_MINUTE
65		));
66		}
67
68		// Prepare the smarty templates used
69		$this->smarty->clearCache(TEMPLATE_DIR . '/mail/' . $template . '.tpl');
70		$this->smarty->clearCache(TEMPLATE_DIR . '/mail/subject.tpl');
71		$this->smarty->assign('WEBSITENAME', $this->setting->getValue('website_name'));
72		$this->smarty->assign('SUBJECT', $aData['subject']);
73		$this->smarty->assign('DATA', $aData);
74
75		// Create new message for Swiftmailer
76		$senderEmail = $this->setting->getValue('website_email', '[email protected]');
77		$senderName = $this->setting->getValue('website_name', '[email protected]');
78		$message = Swift_Message::newInstance()
79		->setSubject($this->smarty->fetch(TEMPLATE_DIR . '/mail/subject.tpl'))
80		->setFrom(array( $senderEmail => $senderName))
81		->setTo($aData['email'])
82		->setSender($senderEmail)
83		->setReturnPath($senderEmail)
84		->setBody($this->smarty->fetch(TEMPLATE_DIR . '/mail/' . $template . '.tpl'), 'text/html');
85		if (isset($aData['senderName']) &&
86		isset($aData['senderEmail']) &&
87		strlen($aData['senderName']) > 0 &&
88		strlen($aData['senderEmail']) > 0 &&
89		filter_var($aData['senderEmail'], FILTER_VALIDATE_EMAIL))
90		$message->setReplyTo(array($aData['senderEmail'] => $aData['senderName']));
91
92		// Send message out with configured transport
93		try {
94		if ($mailer->send($message)) return true;
95		} catch (Exception $e) {
96		$this->setErrorMessage($e->getMessage());
97		return false;
98		}
99		$this->setErrorMessage($this->sqlError('E0031'));
100		return false;
101		}
102		}
103
104		// Make our class available automatically
105		$mail = new Mail ();
106		$mail->setDebug($debug);
107		$mail->setMysql($mysqli);
108		$mail->setSmarty($smarty);
109		$mail->setConfig($config);
110		$mail->setSetting($setting);
111		$mail->setErrorCodes($aErrorCodes);
112

MPOS / php-mpos

Push — development ( 6dab6b...1d32e1 )

Mail::contactform() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like