Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\DoctorTask

Complexity

Total Complexity

6

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

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

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Runs the silverstripe/upgrade task "environment". See:
 * https://github.com/silverstripe/silverstripe-upgrader#environment.
 * You can use this command to migrate an SilverStripe 3 _ss_environment.php
 * file to the .env format used by SilverStripe 4.'
 */
class DoctorTask extends Task
{
    protected $taskStep = 's30';

    protected $param1 = '';

    protected $param2 = '';

    protected $rootDirForCommand = '';

    public function getTitle()
    {
        return 'Fix up .htaccess and index.html';
    }

    public function getDescription()
    {
        return '
            Runs the silverstripe/upgrade task "doctor". See:
            https://github.com/silverstripe/silverstripe-upgrader#doctor.
            CAREFUL: will remove any customisations!';
    }

    public function runActualTask($params = []): ?string
    {
        if ($this->mu()->getIsModuleUpgrade()) {

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

It seems like getIsModuleUpgrade() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            //do nothing ...
        } else {
            $this->runSilverstripeUpgradeTask(
                'doctor',
                $this->param1,
                $this->param2,
                $this->rootDirForCommand
            );
            $this->setCommitMessage('API:  changing environment file(s)');
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        if ($this->mu()->getIsModuleUpgrade()) {
            return false;
        }
        return true;
    }
}