gplcart\modules\installer\handlers\Download

Complexity

Total Complexity

14

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	process()	0	14	2
B	install()	0	23	4
A	download()	0	15	2
A	countErrors()	0	10	2
A	logErrors()	0	5	1
A	setError()	0	6	2

<?php

/**
 * @package Installer
 * @author Iurii Makukh
 * @copyright Copyright (c) 2017, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\installer\handlers;

use gplcart\core\models\FileTransfer;
use gplcart\modules\installer\models\Install;

/**
 * Handler for Installer module
 */
class Download
{

    /**
     * Language model instance
     * @var \gplcart\core\models\Language $language
     */
    protected $language;

    /**
     * Installer model class instance
     * @var \gplcart\modules\installer\models\Install $install
     */
    protected $install;

    /**
     * File transfer model instance
     * @var \gplcart\core\models\FileTransfer $file_transfer
     */
    protected $file_transfer;

    /**
     * An array of errors
     * @var array
     */
    protected $errors = array();

    /**
     * An array of the current job
     * @var array
     */
    protected $job = array();

    /**
     * The current processing URL
     * @var string
     */
    protected $data_url;

    /**
     * Download constructor.
     * @param FileTransfer $file_transfer
     * @param Install $install
     */
    public function __construct(FileTransfer $file_transfer, Install $install)
    {
        $this->install = $install;
        $this->file_transfer = $file_transfer;
    }

    /**
     * Processes one job iteration
     * @param array $job
     */
    public function process(array &$job)
    {
        $this->job = &$job;
        $this->errors = array();

        if (empty($this->job['data']['sources'][$this->job['done']])) {
            $this->job['status'] = false;
            $this->job['done'] = $this->job['total'];
        } else {
            $this->install();
            $this->job['done']++;
            $this->job['errors'] += $this->countErrors();
        }
    }

    /**
     * Install a module
     * @return boolean
     */
    protected function install()
    {
        $file = $this->download();

        if (empty($file)) {
            return false;
        }

        $result = $this->install->fromZip($file);

It seems like $file defined by $this->download() on line 93 can also be of type boolean; however, gplcart\modules\installer\models\Install::fromZip() does only seem to accept string, maybe add an additional type check?

        if ($result !== true) {
            $this->setError($result);

$result is of type null|boolean, but the function expects a string|array.

            return false;
        }

        if ($this->install->isUpdate()) {
            $this->job['updated']++;
        } else {
            $this->job['inserted']++;
        }

        return true;
    }

    /**
     * Download a module file from a remote source
     * @return boolean|string
     */
    protected function download()
    {
        $this->data_url = $this->job['data']['sources'][$this->job['done']];

        $filename = md5($this->data_url);
        $destination = gplcart_file_private_module('installer', "$filename.zip", true);
        $result = $this->file_transfer->download($this->data_url, 'zip', $destination);

        if ($result === true) {
            return $this->file_transfer->getTransferred();
        }

        $this->setError($result);
        return false;
    }

    /**
     * Returns a total number of errors and logs them
     * @return integer
     */
    protected function countErrors()
    {
        $count = 0;
        foreach ($this->errors as $url => $errors) {
            $errors = array_filter($errors);
            $count += count($errors);
            $this->logErrors($url, $errors);
        }
        return $count;
    }

    /**
     * Logs all errors happened for the URL
     * @param integer $url
     * @param array $errors
     * @return boolean
     */
    protected function logErrors($url, array $errors)
    {
        $data = array($url, implode(PHP_EOL, $errors));
        return gplcart_file_csv($this->job['log']['errors'], $data);
    }

    /**
     * Sets a error
     * @param string|array $error
     */
    protected function setError($error)
    {
        settype($error, 'array');
        $existing = empty($this->errors[$this->data_url]) ? array() : $this->errors[$this->data_url];
        $this->errors[$this->data_url] = gplcart_array_merge($existing, $error);
    }

}