Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\CheckThatFoldersAreReady

Complexity

Total Complexity

9

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	runActualTask()	0	27	6
A	getDescription()	0	3	1
A	getTitle()	0	3	1
A	hasCommitAndPush()	0	3	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Checks that all the directories needed to run this tool exist and are writable.
 */
class CheckThatFoldersAreReady extends Task
{
    protected $taskStep = 's10';

    public function getTitle()
    {
        return 'Check Folders Are Ready';
    }

    public function getDescription()
    {
        return '
            Checks that all the directories needed to run this tool exist and are writable.
            ';
    }

    /**
     * Checks that the required folder variables link to folders that file_exists
     * and which are writable.
     */
    public function runActualTask($params = [])
    {
        $abovewebdir = $this->mu()->getAboveWebRootDirLocation();

The method getAboveWebRootDirLocation() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

        //check dir above web dir exists
        if (! file_exists($abovewebdir)) {
            $this->mu()->colourPrint('Above web dir does not exists: ' . $abovewebdir, 'red');
            return 'No point in running tool with directory not ready';
        }
        //Directory exists, now check if writable.
        if (! is_writable($abovewebdir)) {
            //Not writable send warning
            $this->mu()->colourPrint('Above web dir is not writable: ' . $abovewebdir, 'red');
            return 'No point in running tool with directory not ready';
        }
        //It has been found and is writable; Success!
        $this->mu()->colourPrint('Found and checked above web dir ✔', 'green');

        //LogFileLocation
        $logDir = $this->mu()->getLogFolderDirLocation();

The method getLogFolderDirLocation() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

        if ($logDir) {
            //check that log dir is exists
            if (! file_exists($logDir)) {
                return 'Log dir not exists: ' . $logDir . ' set your log dir to an empty string if you prefer to continue without a log.';
            }
            //Directory exists, now check if writable.
            if (! is_writable($logDir)) {
                return $logDir . ' is not writable' . '. Set the log dir to an empty string or provide a writable directory. ';
            }
            //all ok
        }
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}