Sunnysideup\UpgradeToSilverstripe4\UpgradeRecipes\BaseClass

Complexity

Total Complexity

4

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	returnValidValue()	0	6	2
A	getVariables()	0	8	2

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\UpgradeRecipes;

abstract class BaseClass
{
    protected $varsToProvide = [
        'nameOfUpgradeStarterBranch',
        'nameOfTempBranch',
        'defaultNamespaceForTasks',
        'taskSteps',
        'listOfTasks',
        'frameworkComposerRestraint',
    ];

    /**
     * A list of task groups
     *
     * @var array
     */
    protected $taskSteps = [
        's00' => 'Generic',
        's10' => 'Prepare Codebase',
        's20' => 'Upgrade Structure',
        's30' => 'Prepare Code',
        's40' => 'Upgrade Code',
        's50' => 'Upgrade Fixes',
        's60' => 'Check',
        's70' => 'Finalise',
        's99' => 'ERROR!',
    ];

    public function getVariables(): array
    {
        $returnArray = [];
        foreach ($this->varsToProvide as $var) {
            $returnArray[$var] = $this->returnValidValue($var);
        }

        return $returnArray;
    }

    protected function returnValidValue($nameOfVar)
    {
        if (empty($this->{$nameOfVar}) === true) {
            return user_error('You have not defined a variable "' . $nameOfVar . '" in your recipe: ' . self::class);
        }
        return $this->{$nameOfVar};
    }
}