Rossmitchell\Twofactor\Block\Customer\Account\Edit\QRCode

Complexity

Total Complexity

6

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	getCustomer()	0	4	1
A	shouldQrCodeBeDisplayed()	0	12	3
A	getQrCode()	0	9	1

<?php
/**
 * A two factor authentication module that protects both the admin and customer logins
 * Copyright (C) 2017  Ross Mitchell
 *
 * This file is part of Rossmitchell/Twofactor.
 *
 * Rossmitchell/Twofactor 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 Rossmitchell\Twofactor\Block\Customer\Account\Edit;

use Magento\Customer\Api\Data\CustomerInterface;
use Magento\Framework\View\Element\Template;
use Rossmitchell\Twofactor\Model\Config\Customer as CustomerConfig;
use Rossmitchell\Twofactor\Model\Customer\Attribute\TwoFactorSecret;
use Rossmitchell\Twofactor\Model\Customer\Customer;
use Rossmitchell\Twofactor\Model\GoogleTwoFactor\QRCode as QRCodeGenerator;

class QRCode extends Template
{
    /**
     * @var QRCodeGenerator
     */
    private $qRCode;
    /**
     * @var TwoFactorSecret
     */
    private $twoFactorSecret;
    /**
     * @var Customer
     */
    private $customerGetter;
    /**
     * @var CustomerConfig
     */
    private $customerConfig;

    /**
     * QRCode constructor.
     *
     * @param Template\Context $context
     * @param QRCodeGenerator  $qRCode
     * @param TwoFactorSecret  $twoFactorSecret
     * @param Customer         $customerGetter
     * @param CustomerConfig   $customerConfig
     * @param array            $data
     */
    public function __construct(
        Template\Context $context,
        QRCodeGenerator $qRCode,
        TwoFactorSecret $twoFactorSecret,
        Customer $customerGetter,
        CustomerConfig $customerConfig,
        array $data = []
    ) {
        parent::__construct($context, $data);
        $this->qRCode          = $qRCode;
        $this->twoFactorSecret = $twoFactorSecret;
        $this->customerGetter  = $customerGetter;
        $this->customerConfig  = $customerConfig;
    }

    /**
     * A simple getter method to return the current customer
     *
     * @return CustomerInterface
     */
    public function getCustomer()
    {
        return $this->customerGetter->getCustomer();

The expression $this->customerGetter->getCustomer(); of type Magento\Customer\Api\Data\CustomerInterface|false adds false to the return on line 82 which is incompatible with the return type documented by Rossmitchell\Twofactor\Block\Customer\Account\Edit\QRCode::getCustomer of type Magento\Customer\Api\Data\CustomerInterface. It seems like you forgot to handle an error condition.

    }

    /**
     * Used to check if the code should be displayed - will return false if two factor is disabled in the config, or if
     * the customer does not have a code. Otherwise returns true
     *
     * @param CustomerInterface $customer
     *
     * @return bool#

The doc-type bool# could not be parsed: Unknown type name "bool#" at position 0. (view supported doc-types)

     */
    public function shouldQrCodeBeDisplayed(CustomerInterface $customer)
    {
        if ($this->customerConfig->isTwoFactorEnabled() === false) {
            return false;
        }

        if ($this->twoFactorSecret->hasValue($customer) === false) {
            return false;
        }

        return true;
    }

    /**
     * Used to get the customers QR Code. Will return false if they don't have one, otherwise will return the image
     * string
     *
     * @param CustomerInterface $customer
     *
     * @return bool|string
     */
    public function getQrCode(CustomerInterface $customer)
    {
        $secret      = $this->twoFactorSecret->getValue($customer);
        $email       = $customer->getEmail();
        $companyName = $this->customerConfig->getCompanyName();
        $qrCode      = $this->qRCode->generateQRCode($companyName, $email, $secret);

        return $qrCode;
    }
}