BFW\Core\AppSystems\ModuleList

Complexity

Total Complexity

17

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	runModule()	0	11	1
A	getModuleList()	0	3	1
A	toRun()	0	3	1
A	run()	0	7	1
A	runAllAppModules()	0	8	4
A	loadAllModules()	0	16	3
A	__invoke()	0	3	1
A	runAllCoreModules()	0	16	4

<?php

namespace BFW\Core\AppSystems;

class ModuleList extends AbstractSystem
{
    /**
     * @var \BFW\Core\ModuleList $moduleList
     */
    protected $moduleList;
    
    /**
     * Initialize the ModuleList system
     */
    public function __construct()
    {
        $this->moduleList = new \BFW\Core\ModuleList;
    }
    
    /**
     * {@inheritdoc}
     * 
     * @return \BFW\Core\ModuleList
     */
    public function __invoke()
    {
        return $this->moduleList;
    }

    /**
     * Getter accessor to property moduleList
     * 
     * @return \BFW\Core\ModuleList
     */
    public function getModuleList()
    {
        return $this->moduleList;
    }
    
    /**
     * {@inheritdoc}
     */
    public function toRun(): bool
    {
        return true;
    }
    
    /**
     * {@inheritdoc}
     * 
     * Load all modules, run all core and app modules
     */
    public function run()
    {
        $this->loadAllModules();
        $this->runAllCoreModules();
        $this->runAllAppModules();
        
        $this->runStatus = true;
    }
    
    /**
     * Read all directories in modules directory and add each module to Modules
     * class.
     * Generate the load tree.
     * Not initialize modules !
     * 
     * @return void
     */
    protected function loadAllModules()
    {
        $listModules = array_diff(scandir(MODULES_ENABLED_DIR), ['.', '..']);

It seems like scandir(BFW\Core\AppSystems\MODULES_ENABLED_DIR) can also be of type false; however, parameter $array1 of array_diff() does only seem to accept array, maybe add an additional type check?

The constant BFW\Core\AppSystems\MODULES_ENABLED_DIR was not found. Maybe you did not declare it correctly or list all dependencies?

        foreach ($listModules as $moduleName) {
            $modulePath = realpath(MODULES_ENABLED_DIR.$moduleName); //Symlink

            if (!is_dir($modulePath)) {
                continue;
            }

            $this->moduleList->addModule($moduleName);
        }

        $this->moduleList->readNeedMeDependencies();
        $this->moduleList->generateTree();
    }

    /**
     * Load core modules defined into config bfw file.
     * Only module for controller, router, database and template only.
     * 
     * @return void
     */
    protected function runAllCoreModules()
    {
        $allModules = \BFW\Application::getInstance()
            ->getConfig()
            ->getValue('modules', 'modules.php')
        ;
        
        foreach ($allModules as $moduleInfos) {
            $moduleName    = $moduleInfos['name'];
            $moduleEnabled = $moduleInfos['enabled'];

            if (empty($moduleName) || $moduleEnabled === false) {
                continue;
            }

            $this->runModule($moduleName);
        }
    }

    /**
     * Load all modules (except core).
     * Get the load tree, read him and load all modules with the order
     * declared into the tree.
     * 
     * @return void
     */
    protected function runAllAppModules()
    {
        $tree = $this->moduleList->getLoadTree();

        foreach ($tree as $firstLine) {
            foreach ($firstLine as $secondLine) {
                foreach ($secondLine as $moduleName) {
                    $this->runModule($moduleName);
                }
            }
        }
    }

    /**
     * Load a module
     * 
     * @param string $moduleName The module's name to load
     * 
     * @return void
     */
    protected function runModule(string $moduleName)
    {
        $app = \BFW\Application::getInstance();
        
        $app->getSubjectList()
            ->getSubjectByName('ApplicationTasks')
            ->sendNotify('BfwApp_run_module_'.$moduleName);
        
        $this->moduleList
            ->getModuleByName($moduleName)
            ->runModule();
    }
}