FixRequirements::getDescription() - Code Metrics - sunnysideup/silverstripe-upgrade_to_silverstripe_4 - Measure and Improve Code Quality continuously with Scrutinizer

FixRequirements::getDescription() A
last analyzed 2025-07-13 19:39 UTC

↳ Parent: FixRequirements
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

/**
 * Replaces a bunch of code snippets in preparation of the upgrade.
 * Controversial replacements will be replaced with a comment
 * next to it so you can review replacements easily.
 */
class FixRequirements extends Task
{
    protected $taskStep = 's30';

    protected $debug = false;

    private $ignoreFolderArray = [
        '.git',
    ];

    public function getTitle()
    {
        return 'Finds requirements (Requirements::) and fixes them to be exposed properly';
    }

    public function getDescription()
    {
        return '
            Finds Requirements:: instances and fixes them to be used properly for modules
            - e.g. [vendorname] / [modulename] : location/for/my/script.js';
    }

    public function setIgnoreFolderArray($a)
    {
        $this->ignoreFolderArray = $a;

        return $this;
    }

    public function runActualTask($params = []): ?string
    {
        //replacement data patterns that will be searched for
        $replacementArray = [
            'src' => [
                'php' => [
                    'Requirements::javascript(' => [
                        'R' => '',
                    ],
                    'Requirements::css(' => [
                        'R' => '',
                    ],
                    'Requirements::themedCSS(' => [
                        'R' => '',
                    ],
                ],
            ],
        ];

        if ($this->debug) {
            $this->mu()->colourPrint($replacementArray);
            $this->mu()->/** @scrutinizer ignore-call */ colourPrint($replacementArray);
        }
        foreach ($this->mu()->getExistingModuleDirLocations() as $moduleDir) {
        foreach ($this->mu()->/** @scrutinizer ignore-call */ getExistingModuleDirLocations() as $moduleDir) {
            //Start search machine from the module location. replace API
            $textSearchMachine = new SearchAndReplaceAPI($moduleDir);
            $textSearchMachine->setIsReplacingEnabled(true);
            $textSearchMachine->addToIgnoreFolderArray($this->ignoreFolderArray);

            /*For all the different patterns listed in the replacement array
            * iterate over them such that the $path would be 'src' and $patharray would be 'php'
            * together making it ['src']['php']
            */
            foreach ($replacementArray as $path => $pathArray) {
                $path = $moduleDir . '/' . $path ?: '';
                $path = $this->mu()->checkIfPathExistsAndCleanItUp($path);
                $path = $this->mu()->/** @scrutinizer ignore-call */ checkIfPathExistsAndCleanItUp($path);
                if (! file_exists($path)) {
                    $this->mu()->colourPrint("SKIPPING ${path} as it does not exist.");
                } else {
                    $textSearchMachine->setSearchPath($path);
                    foreach ($pathArray as $extension => $extensionArray) {
                        //setting extensions to search files within
                        $textSearchMachine->setExtensions(explode('|', $extension));
                        $this->mu()->colourPrint(
                            "++++++++++++++++++++++++++++++++++++\n" .
                            "CHECKING\n" .
                            "IN ${path}\n" .
                            "FOR ${extension} FILES\n" .
                            'BASE ' . $moduleDir . "\n" .
                            "++++++++++++++++++++++++++++++++++++\n"
                        );
                        foreach ($extensionArray as $find => $findDetails) {
                            $replace = $findDetails['R'] ?? $find;

                            $caseSensitive = false;

                            $isStraightReplace = true;

                            $replacementType = 'BASIC';

                            // REPLACMENT PATTERN!
                            //Requirements::javascript(moduledirfolder/bla);
                            //Requirements::javascript(vpl: bla);
                            // $findWithPackageName = $find . strtolower($this->mu()->getPackageName());
                            $vendorAndPackageFolderNameForInstall =
                                $this->mu()->getVendorAndPackageFolderNameForInstall();
                                $this->mu()->/** @scrutinizer ignore-call */ getVendorAndPackageFolderNameForInstall();

                            foreach (['\'', '"'] as $quoteMark) {
                                $finalReplace = $find . $quoteMark . $vendorAndPackageFolderNameForInstall . ': ';
                                if (! $finalReplace && $finalReplace !== ' ') {
                                    user_error("
                                        no replace is specified, find is: ${find}.
                                        We suggest setting your final replace to a single space
                                        if you would like to replace with NOTHING.
                                    ");
                                }
                                $finalFind = $find . $quoteMark;
                                $this->mu()->colourPrint(
                                    '    --- FIND: ' . $finalFind . "\n" .
                                    '    --- REPLACE: ' . $finalReplace . "\n"
                                );

                                $textSearchMachine->setSearchKey($finalFind, $caseSensitive, $replacementType);
                                $textSearchMachine->setReplacementKey($finalReplace);
                                $textSearchMachine->startSearchAndReplace();
                            }
                        }

                        //fix double-ups
                        //fixes things like
                        //vendor/packagename: silverstripe/admin
                        //to
                        //silverstripe/admin: only
                        $isCaseSensitive = true;
                        foreach (['cms', 'framework', 'siteconfig', 'reports'] as $ssModule) {
                            $finalFind = $vendorAndPackageFolderNameForInstall . ': silverstripe/' . $ssModule . ': ';

                            $finalReplace = 'silverstripe/' . $ssModule . ': ';
                            $this->mu()->colourPrint(
                                '    --- FIND: ' . $finalFind . "\n" .
                                '    --- REPLACE: ' . $finalReplace . "\n"
                            );
                            $textSearchMachine->setSearchKey(
                                $finalFind,
                                $isCaseSensitive,
                                'silverstripe/' . $ssModule . '/@@@@double-up@@@@'
                            );
                            $textSearchMachine->setReplacementKey($finalReplace);
                            $textSearchMachine->startSearchAndReplace();
                        }

                        //SHOW TOTALS
                        $replacements = $textSearchMachine->showFormattedSearchTotals();
                        if (! $replacements) {
                            //flush output anyway!
                            $this->mu()->colourPrint("No replacements for  ${extension}");
                        }
                        $this->mu()->colourPrint($textSearchMachine->getOutput());
                    }
                }
            }
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}

sunnysideup / silverstripe-upgrade_to_silverstripe_4

FixRequirements::getDescription() A last analyzed 2025-07-13 19:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FixRequirements::getDescription() A
last analyzed 2025-07-13 19:39 UTC
