Helper - Code Metrics - HaaseIT/HCSF - Measure and Improve Code Quality continuously with Scrutinizer

Helper F
last analyzed 2019-11-13 08:51 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	331
Duplicated Lines	7.25 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	81
lcom	1
cbo	3
dl	24
loc	331
rs	2
c	0
b	0
f	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
F	validateCustomerForm()	24	63	37
A	getDefaultCountryByConfig()	0	6	2
A	getCustomerFormDefaultValue()	0	8	3
F	buildCustomerForm()	0	123	25
A	sendVerificationMail()	0	24	3
B	getUserData()	0	20	10

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Helper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Helper, and based on these observations, apply Extract Interface, too.

<?php

/*
    HCSF - A multilingual CMS and Shopsystem
    Copyright (C) 2014  Marcus Haase - [email protected]

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace HaaseIT\HCSF\Customer;

use HaaseIT\Toolbox\Tools;
use Zend\ServiceManager\ServiceManager;

/**
 * Class Helper
 * @package HaaseIT\HCSF\Customer
 */
class Helper
{
    /**
     * @var ServiceManager
     */
    protected $serviceManager;

    /**
     * @var \HaaseIT\HCSF\HelperConfig
     */
    protected $config;

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

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

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

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

    /**
     * @var \HaaseIT\HCSF\Helper
     */
    protected $helper;

    public function __construct(ServiceManager $serviceManager)
    {
        $this->serviceManager = $serviceManager;
        $this->config = $serviceManager->get('config');
        $this->core = $this->config->getCore();
        $this->countries = $this->config->getCountries();
        $this->shop = $this->config->getShop();
        $this->helper = $this->serviceManager->get('helper');
    }

    /**
     * @param string $sLang
     * @param array $aErr
     * @param bool $bEdit
     * @return array
     */
    public function validateCustomerForm($sLang, $aErr = [], $bEdit = false)
    {
        if (empty(filter_input(INPUT_POST, 'email', FILTER_VALIDATE_EMAIL))) {
            $aErr['email'] = true;
        }
        $postcorpname = filter_input(INPUT_POST, 'corpname', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_corpname'] && (empty($postcorpname) || strlen(trim($postcorpname)) < 3)) {

            $aErr['corpname'] = true;
        }
        $postname = filter_input(INPUT_POST, 'name', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_name'] && (empty($postname) || strlen(trim($postname)) < 3)) {

            $aErr['name'] = true;
        }
        $poststreet = filter_input(INPUT_POST, 'street', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_street'] && (empty($poststreet) || strlen(trim($poststreet)) < 3)) {

            $aErr['street'] = true;
        }
        $postzip = filter_input(INPUT_POST, 'zip', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_zip'] && (empty($postzip) || strlen(trim($postzip)) < 4)) {

            $aErr['zip'] = true;
        }
        $posttown = filter_input(INPUT_POST, 'town', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_town'] && (empty($posttown) || strlen(trim($posttown)) < 3)) {

            $aErr['town'] = true;
        }
        $postphone = filter_input(INPUT_POST, 'phone', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_phone'] && (empty($postphone) || strlen(trim($postphone)) < 6)) {

            $aErr['phone'] = true;
        }
        $postcellphone = filter_input(INPUT_POST, 'cellphone', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_cellphone'] && (empty($postcellphone) || strlen(trim($postcellphone)) < 11)) {

            $aErr['cellphone'] = true;
        }
        $postfax = filter_input(INPUT_POST, 'fax', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_fax'] && (empty($postfax) || strlen(trim($postfax)) < 6)) {

            $aErr['fax'] = true;
        }
        $postcountry = filter_input(INPUT_POST, 'country', FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW);
        if ($this->customer['validate_country'] && (empty($postcountry) || !isset($this->countries['countries_' .$sLang][$postcountry]))) {
            $aErr['country'] = true;
        }
        $posttos = filter_input(INPUT_POST, 'tos');
        if (!$bEdit && $posttos !== 'y') {
            $aErr['tos'] = true;
        }
        $postcancellationdisclaimer = filter_input(INPUT_POST, 'cancellationdisclaimer');
        if (!$bEdit && $postcancellationdisclaimer !== 'y') {
            $aErr['cancellationdisclaimer'] = true;
        }

        $postpwd = filter_input(INPUT_POST, 'pwd');
        $postpwdc = filter_input(INPUT_POST, 'pwdc');
        if (!$bEdit || !empty($postpwd)) {
            if (strlen($postpwd) < $this->customer['minimum_length_password']) {
                $aErr['passwordlength'] = true;
            }
            if ($postpwd !== $postpwdc) {
                $aErr['passwordmatch'] = true;
            }
        }

        return $aErr;
    }

    /**
     * @param string $sLang
     * @return string
     */
    public function getDefaultCountryByConfig($sLang) {
        if (isset($this->core['defaultcountrybylang'][$sLang])) {
            return $this->core['defaultcountrybylang'][$sLang];
        }
        return '';
    }

    /**
     * @param string $sKeyConfig
     * @param string $sKeyForm
     * @param array|bool $aUserData
     * @return bool
     */
    public function getCustomerFormDefaultValue($sKeyConfig, $sKeyForm, $aUserData) {
        $sDefaultValue = $this->getUserData($sKeyConfig, $aUserData);

        if (!$sDefaultValue && isset($_SESSION['formsave_addrform'][$sKeyForm])) {
            $sDefaultValue = $_SESSION['formsave_addrform'][$sKeyForm];
        }

        return $sDefaultValue;
    }

    /**
     * @param string $sLang
     * @param string $sPurpose
     * @param array $aErr
     * @param bool $aUserData
     * @return array
     */
    public function buildCustomerForm($sLang, $sPurpose = 'none', $aErr = [], $aUserData = false)
    {
        $sDefaultCountry = $this->getCustomerFormDefaultValue('cust_country', 'country', $aUserData);

        // Purposes: shoppingcart, userhome, shopadmin, editprofile, register
        // fv = field_value, fr = field_required
        $aData = [
            'purpose' => $sPurpose,
            'errormessage' => $aErr,
            'readonlycustno' => $sPurpose === 'shopadmin' ? true : false,
            'readonly' =>
                $sPurpose === 'shopadmin'
                || $sPurpose === 'userhome'
                || ($sPurpose === 'editprofile' && !$this->customer['allow_edituserprofile'])
                || ($sPurpose === 'shoppingcart' && $this->getUserData())
            ,
            'fv_custno' => Tools::getFormfield(
                'custno',
                $this->getCustomerFormDefaultValue('cust_no', 'custno', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fv_email' => Tools::getFormfield(
                'email',
                $this->getCustomerFormDefaultValue('cust_email', 'email', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fv_corpname' => Tools::getFormfield(
                'corpname',
                $this->getCustomerFormDefaultValue('cust_corp', 'corpname', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_corpname' => $this->customer['validate_corpname'],
            'fv_name' => Tools::getFormfield(
                'name',
                $this->getCustomerFormDefaultValue('cust_name', 'name', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_name' => $this->customer['validate_name'],
            'fv_street' => Tools::getFormfield(
                'street',
                $this->getCustomerFormDefaultValue('cust_street', 'street', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_street' => $this->customer['validate_street'],
            'fv_zip' => Tools::getFormfield(
                'zip',
                $this->getCustomerFormDefaultValue('cust_zip', 'zip', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_zip' => $this->customer['validate_zip'],
            'fv_town' => Tools::getFormfield(
                'town',
                $this->getCustomerFormDefaultValue('cust_town', 'town', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_town' => $this->customer['validate_town'],
            'fv_phone' => Tools::getFormfield(
                'phone',
                $this->getCustomerFormDefaultValue('cust_phone', 'phone', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_phone' => $this->customer['validate_phone'],
            'fv_cellphone' => Tools::getFormfield(
                'cellphone',
                $this->getCustomerFormDefaultValue('cust_cellphone', 'cellphone', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_cellphone' => $this->customer['validate_cellphone'],
            'fv_fax' => Tools::getFormfield(
                'fax',
                $this->getCustomerFormDefaultValue('cust_fax', 'fax', $aUserData),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                true
            ),
            'fr_fax' => $this->customer['validate_fax'],
            'fv_country' => Tools::getFormfield(
                'country',
                ($sDefaultCountry ? $sDefaultCountry : $this->getDefaultCountryByConfig($sLang)),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                true
            ),
            'fr_country' => $this->customer['validate_country'],
        ];

        if ($sPurpose === 'admin') {
            $aData['fv_custgroups'] = $this->customer['customer_groups'];
            $aData['fv_custgroup_selected'] = Tools::getFormfield('custgroup', $this->getUserData('cust_group', $aUserData), true);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } elseif ($sPurpose === 'shopadmin') {
            $aData['fv_custgroup'] = '';
            if (isset($this->customer['customer_groups'][$this->getUserData('cust_group', $aUserData)])) {
                $aData['fv_custgroup'] = $this->customer['customer_groups'][$this->getUserData('cust_group', $aUserData)];
            }
        }

        if ($sPurpose === 'admin' || $sPurpose === 'register' || $sPurpose === 'editprofile') {
            $aData['fv_pwd'] = (($sPurpose === 'admin' || $sPurpose === 'editprofile') ? '' : Tools::getFormfield('pwd', ''));
            $aData['fv_pwdc'] = (($sPurpose === 'admin' || $sPurpose === 'editprofile') ? '' : Tools::getFormfield('pwdc', ''));
        }

        if ($sPurpose === 'shoppingcart') {
            $sRememberedRemarks = '';
            if (isset($_SESSION['formsave_addrform']['remarks'])) {
                $sRememberedRemarks = $_SESSION['formsave_addrform']['remarks'];
            }
            $aData['fv_remarks'] = Tools::getFormfield('remarks', $sRememberedRemarks, true);
        }

        if ($sPurpose === 'shoppingcart' || $sPurpose === 'register') {
            if (!$this->getUserData()) {
                $aData['fv_tos'] = Tools::getCheckbox('tos', 'y');
                $aData['fv_cancellationdisclaimer'] = Tools::getCheckbox('cancellationdisclaimer', 'y');
            }
        }

        if ($sPurpose === 'shoppingcart') {
            $aData['fv_paymentmethods'] = $this->shop['paymentmethods'];
            $aData['fv_paymentmethod'] = Tools::getFormfield('paymentmethod', '');
        }

        if ($sPurpose === 'admin') {
            $aData['fv_active'] = $this->getUserData('cust_active', $aUserData) === 'y';
            $aData['fv_emailverified'] = $this->getUserData('cust_emailverified', $aUserData) === 'y';
        }
        return $aData;
    }

    /**
     * @param $sEmailVerificationcode
     * @param $sTargetAddress
     * @param ServiceManager $serviceManager
     * @param bool $bCust
     */
    public function sendVerificationMail($sEmailVerificationcode, $sTargetAddress, ServiceManager $serviceManager, $bCust = false)
    {
        if ($bCust) {
            $sSubject = $serviceManager->get('textcats')->T('register_mail_emailverification_subject');

            $serverhttps = filter_input(INPUT_SERVER, 'HTTPS');
            $servername = filter_input(INPUT_SERVER, 'SERVER_NAME', FILTER_SANITIZE_URL);
            $aP['link'] = 'http'.($serverhttps === 'on' ? 's' : '').'://';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
            $aP['link'] .= $servername.'/_misc/verifyemail.html?key='.$sEmailVerificationcode;

            $sMessage = $serviceManager->get('twig')->render('customer/sendverificationmail.twig', $aP);
        } else {
            $hardcodedtextcats = $serviceManager->get('hardcodedtextcats');

            $sSubject = $hardcodedtextcats->get('newcustomerregistration_mail_subject');
            $sMessage = $hardcodedtextcats->get('newcustomerregistration_mail_text1').' ';
            $sMessage .= $sTargetAddress.$hardcodedtextcats->get(
                'newcustomerregistration_mail_text2').' '.date($this->core['locale_format_date_time']
                );
            $sTargetAddress = $this->core['email_sender'];
        }

        $this->helper->mailWrapper($sTargetAddress, $sSubject, $sMessage);
    }

    /**
     * @param string $sField
     * @param bool $aUserdata
     * @return bool
     */
    public function getUserData($sField = '', $aUserdata = false)
    {
        if (!$aUserdata) {
            if (!isset($_SESSION['user']) || !is_array($_SESSION['user'])) {
                return false;
            } elseif ($sField === '') {
                return true;
            }

            if ($sField !== '' && isset($_SESSION['user'][$sField]) && $_SESSION['user'][$sField] !== '') {
                return $_SESSION['user'][$sField];
            }
        } else {
            if (isset($aUserdata[$sField])) {
                return $aUserdata[$sField];
            } elseif ($sField === '') {
                return false;
            }
        }
    }
}


HaaseIT / HCSF

Helper F last analyzed 2019-11-13 08:51 UTC