ModuleInstall::addToList() - Code Metrics - Inspection of "Rewrite Application class to split core system and..." - bfw-systems/bfw - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.0 ( fea5eb...c29f0e )

by Vermeulen

created 2018-08-03 16:17 UTC

ModuleInstall::addToList() A

↳ Parent: ModuleInstall

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace BFW\Install\Core\AppSystems;

use \BFW\Core\AppSystems\AbstractSystem;
use \BFW\Helpers\Cli;

class ModuleInstall extends AbstractSystem
{
    /**
     * @var \BFW\Install\ModuleInstall[] $listToInstall
     */
    protected $listToInstall = [];
    
    /**
     * {@inheritdoc}
     * 
     * @return $this
     */
    public function __invoke()
    {
        return $this;
    }
    
    /**
     * Getter accessor to property listToInstall
     * 
     * @return type
     */
    public function getListToInstall()
    {
        return $this->listToInstall;
    }
    
    /**
     * {@inheritdoc}
     */
    public function init()
    {
        $this->initStatus = true;
    }
    
    /**
     * {@inheritdoc}
     */
    public function toRun()
    {
        return true;
    }
    
    /**
     * {@inheritdoc}
     * Run install of all modules
     */
    public function run()
    {
        $this->installAllModules();
        $this->runStatus = true;
    }
    
    /**
     * Add a new module to the list to install
     * 
     * @param \BFW\Install\ModuleInstall $module The new module
     * 
     * @return $this
     */
    public function addToList(\BFW\Install\ModuleInstall $module)
    {
        $moduleName = $module->getName();
        
        $this->listToInstall[$moduleName] = $module;
        
        return $this;
    }
    
    /**
     * Install all modules in the order of the dependency tree.
     * 
     * @return void
     */
    protected function installAllModules()
    {
        Cli::displayMsgNL('Read all modules to run install script...');
        
        $tree = \BFW\Install\Application::getInstance()
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            ->getModuleList()
            ->getLoadTree()
        ;

        foreach ($tree as $firstLine) {
            foreach ($firstLine as $secondLine) {
                foreach ($secondLine as $moduleName) {
                    if (!isset($this->listToInstall[$moduleName])) {
                        continue;
                    }
                    
                    $this->installModule($moduleName);
                }
            }
        }
        
        Cli::displayMsgNL('All modules have been read.');
    }
    
    /**
     * Install a module
     * 
     * @param string $moduleName The module name
     * 
     * @return void
     */
    protected function installModule($moduleName)
    {
        if (!isset($this->listToInstall[$moduleName])) {
            return;
        }
        
        Cli::displayMsgNL(' > Read for module '.$moduleName);
        
        $module         = $this->listToInstall[$moduleName];
        $installScripts = $module->getSourceInstallScript();
        
        if ($installScripts === '') {
            Cli::displayMsgNL(' >> No script to run.');
            return;
        }
        
        if (is_string($installScripts)) {
            $installScripts = (array) $installScripts;
        }
        
        foreach ($installScripts as $scriptPath) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $module->runInstallScript($scriptPath);
        }
    }
}


1			<?php
2
3			namespace BFW\Install\Core\AppSystems;
4
5			use \BFW\Core\AppSystems\AbstractSystem;
6			use \BFW\Helpers\Cli;
7
8			class ModuleInstall extends AbstractSystem
9			{
10			/**
11			* @var \BFW\Install\ModuleInstall[] $listToInstall
12			*/
13			protected $listToInstall = [];
14
15			/**
16			* {@inheritdoc}
17			*
18			* @return $this
19			*/
20			public function __invoke()
21			{
22			return $this;
23			}
24
25			/**
26			* Getter accessor to property listToInstall
27			*
28			* @return type
29			*/
30			public function getListToInstall()
31			{
32			return $this->listToInstall;
33			}
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function init()
39			{
40			$this->initStatus = true;
41			}
42
43			/**
44			* {@inheritdoc}
45			*/
46			public function toRun()
47			{
48			return true;
49			}
50
51			/**
52			* {@inheritdoc}
53			* Run install of all modules
54			*/
55			public function run()
56			{
57			$this->installAllModules();
58			$this->runStatus = true;
59			}
60
61			/**
62			* Add a new module to the list to install
63			*
64			* @param \BFW\Install\ModuleInstall $module The new module
65			*
66			* @return $this
67			*/
68			public function addToList(\BFW\Install\ModuleInstall $module)
69			{
70			$moduleName = $module->getName();
71
72			$this->listToInstall[$moduleName] = $module;
73
74			return $this;
75			}
76
77			/**
78			* Install all modules in the order of the dependency tree.
79			*
80			* @return void
81			*/
82			protected function installAllModules()
83			{
84			Cli::displayMsgNL('Read all modules to run install script...');
85
86			$tree = \BFW\Install\Application::getInstance()
			0 ignored issues – show Documentation Bug introduced 2018-08-03 16:19 UTC by Report Bug Copy Issue Report The method `getModuleList` does not exist on `object<BFW\Application>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
87			->getModuleList()
88			->getLoadTree()
89			;
90
91			foreach ($tree as $firstLine) {
92			foreach ($firstLine as $secondLine) {
93			foreach ($secondLine as $moduleName) {
94			if (!isset($this->listToInstall[$moduleName])) {
95			continue;
96			}
97
98			$this->installModule($moduleName);
99			}
100			}
101			}
102
103			Cli::displayMsgNL('All modules have been read.');
104			}
105
106			/**
107			* Install a module
108			*
109			* @param string $moduleName The module name
110			*
111			* @return void
112			*/
113			protected function installModule($moduleName)
114			{
115			if (!isset($this->listToInstall[$moduleName])) {
116			return;
117			}
118
119			Cli::displayMsgNL(' > Read for module '.$moduleName);
120
121			$module = $this->listToInstall[$moduleName];
122			$installScripts = $module->getSourceInstallScript();
123
124			if ($installScripts === '') {
125			Cli::displayMsgNL(' >> No script to run.');
126			return;
127			}
128
129			if (is_string($installScripts)) {
130			$installScripts = (array) $installScripts;
131			}
132
133			foreach ($installScripts as $scriptPath) {
			0 ignored issues – show Bug introduced 2017-05-08 22:49 UTC by Report Bug Copy Issue Report The expression `$installScripts` of type `array\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
134			$module->runInstallScript($scriptPath);
135			}
136			}
137			}
138

bfw-systems / bfw

GitHub Access Token became invalid

Push — 3.0 ( fea5eb...c29f0e )

ModuleInstall::addToList() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like