Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\CreatePublicFolder

Complexity

Total Complexity

5

Size/Duplication

Total Lines	41
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	4	1
A	hasCommitAndPush()	0	3	1
A	runActualTask()	0	15	2

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Api\FileSystemFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * This task adds a legacy branch to the git repo of the original to act as a backup/legacy version for
 * holding a version of the module before it was changed
 */
class CreatePublicFolder extends Task
{
    protected $taskStep = 's10';

    protected $publicFolderName = 'public';

    public function getTitle()
    {
        return 'Create a public folder to match SS4 folder structure';
    }

    public function getDescription()
    {
        return '
            For projects only, we create a public folder: ' . $this->mu()->getWebRootDirLocation() . '/public';

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

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

    }

    /**
     * [runActualTask description]
     * @param  array  $params not currently used for this task
     */
    public function runActualTask($params = []): ?string
    {
        if ($this->mu()->getIsProjectUpgrade()) {

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

            $newFolder = $this->mu()->getWebRootDirLocation() . '/' . $this->publicFolderName;
            FileSystemFixes::inst($this->mu())
                ->mkDir($newFolder);

            $this->mu()->execMe(

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

                $newFolder,
                'echo \'hello world\' >> hello-world.html',
                'adding public test file',
                false
            );
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return $this->mu()->getIsProjectUpgrade();
    }
}