getnet-adquirencia / payment-magento

Gateway/Config/ConfigPix.php

<?php
/**
 * Copyright © Getnet. All rights reserved.
 *
 * @author    Bruno Elisei <brunoelisei@o2ti.com>
 * See LICENSE for license details.
 */
declare(strict_types=1);

namespace Getnet\PaymentMagento\Gateway\Config;

use BaconQrCode\Renderer\Image\SvgImageBackEnd;
use BaconQrCode\Renderer\ImageRenderer;
use BaconQrCode\Renderer\RendererStyle\RendererStyle;
use BaconQrCode\Writer;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\WriteInterface;
use Magento\Framework\Filesystem\Io\File;
use Magento\Payment\Gateway\Config\Config as PaymentConfig;
use Magento\Store\Model\ScopeInterface;

/**
 * Class ConfigPix - Returns form of payment configuration properties.
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class ConfigPix extends PaymentConfig
{
    /**
     * @const string
     */
    public const METHOD = 'getnet_paymentmagento_pix';

    /**
     * @const string
     */
    public const ACTIVE = 'active';

    /**
     * @const string
     */
    public const TITLE = 'title';

    /**
     * @const string
     */
    public const INSTRUCTION_CHECKOUT = 'instruction_checkout';

    /**
     * @var ScopeConfigInterface
     */
    protected $scopeConfig;

    /**
     * @var File
     */
    protected $fileIo;

    /**
     * @var Filesystem
     */
    protected $filesystem;

    /**
     * @var Config
     */
    protected $config;

    /**
     * @param ScopeConfigInterface $scopeConfig
     * @param File                 $fileIo
     * @param Filesystem           $filesystem
     * @param DirectoryList        $directoryList
     * @param Config               $config
     * @param string|null          $methodCode
     */
    public function __construct(
        ScopeConfigInterface $scopeConfig,
        File $fileIo,
        Filesystem $filesystem,
        DirectoryList $directoryList,
        Config $config,
        $methodCode = null
    ) {
        parent::__construct($scopeConfig, $methodCode);
        $this->scopeConfig = $scopeConfig;
        $this->fileIo = $fileIo;
        $this->filesystem = $filesystem;
        $this->directoryList = $directoryList;

The property directoryList does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->config = $config;
    }

    /**
     * Get Payment configuration status.
     *
     * @param int|null $storeId
     *
     * @return bool
     */
    public function isActive($storeId = null): bool
    {
        $pathPattern = 'payment/%s/%s';

        return (bool) $this->scopeConfig->getValue(
            sprintf($pathPattern, self::METHOD, self::ACTIVE),
            ScopeInterface::SCOPE_STORE,
            $storeId
        );
    }

    /**
     * Get title of payment.
     *
     * @param int|null $storeId
     *
     * @return string|null
     */
    public function getTitle($storeId = null): ?string
    {
        $pathPattern = 'payment/%s/%s';

        return $this->scopeConfig->getValue(
            sprintf($pathPattern, self::METHOD, self::TITLE),
            ScopeInterface::SCOPE_STORE,
            $storeId
        );
    }

    /**
     * Get Instruction - Checkoout.
     *
     * @param int|null $storeId
     *
     * @return string|null
     */
    public function getInstructionCheckout($storeId = null): ?string
    {
        $pathPattern = 'payment/%s/%s';

        return $this->scopeConfig->getValue(
            sprintf($pathPattern, self::METHOD, self::INSTRUCTION_CHECKOUT),
            ScopeInterface::SCOPE_STORE,
            $storeId
        );
    }

    /**
     * Generate Image Qr Code.
     *
     * @param string $qrCode
     * @param string $transactionId
     *
     * @return string
     */
    public function generateImageQrCode($qrCode, $transactionId)
    {
        $fileName = null;
        if ($this->hasPathDir()) {
            $fileName = 'getnet/pix/'.$transactionId.'.svg';
            $mediaDirectory = $this->filesystem->getDirectoryWrite(DirectoryList::MEDIA);
            $filePath = $this->getPathFile($mediaDirectory, $transactionId);

$mediaDirectory of type Magento\Framework\Filesystem\Directory\WriteInterface is incompatible with the type string expected by parameter $mediaDirectory of Getnet\PaymentMagento\Gateway\Config\ConfigPix::getPathFile().

            $generate = $this->createImageQrCode($mediaDirectory, $filePath, $qrCode);
            if (!$generate) {
                return false;

The expression return false returns the type false which is incompatible with the documented return type string.

            }
        }

        return $fileName;
    }

    /**
     * Get Path File.
     *
     * @param string $mediaDirectory
     * @param string $transactionId
     *
     * @return string
     */
    public function getPathFile($mediaDirectory, $transactionId): string
    {
        $filePath = $mediaDirectory->getAbsolutePath('getnet/pix/'.$transactionId.'.svg');

        return $filePath;
    }

    /**
     * Create Image Qr Code.
     *
     * @param WriteInterface $writeDirectory
     * @param string         $filePath
     * @param string         $qrCode
     *
     * @throws FileSystemException
     *
     * @return bool
     */
    public function createImageQrCode(WriteInterface $writeDirectory, $filePath, $qrCode): bool
    {
        try {
            $stream = $writeDirectory->openFile($filePath, 'w+');
            $stream->lock();
            $renderer = new ImageRenderer(
                new RendererStyle(200),
                new SvgImageBackEnd()
            );
            $writer = new Writer($renderer);
            $image = $writer->writeString($qrCode);
            $stream->write($image);
            $stream->unlock();
            $stream->close();
        } catch (FileSystemException $ex) {

The type Getnet\PaymentMagento\Gateway\Config\FileSystemException was not found. Maybe you did not declare it correctly or list all dependencies?

            new Phrase($ex->getMessage());

The type Getnet\PaymentMagento\Gateway\Config\Phrase was not found. Maybe you did not declare it correctly or list all dependencies?

            return false;
        }

        return true;
    }

    /**
     * Check or Create Dir.
     *
     * @return bool
     */
    public function hasPathDir(): bool
    {
        $pixPath = $this->filesystem->getDirectoryRead(DirectoryList::MEDIA)->getAbsolutePath('/getnet/pix');

        return $this->fileIo->checkAndCreateFolder($pixPath);
    }
}