Samurai\Module\Module

Complexity

Total Complexity

22

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

96.43%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isEnable()	0	4	1
A	getIsEnable()	0	4	1
A	setIsEnable()	0	4	1
A	getDependencies()	0	4	1
A	setDependencies()	0	7	2
A	retrieveDependents()	0	15	4
A	getTasks()	0	4	1
A	setTasks()	0	4	1
A	toArray()	0	11	1
A	buildModulesFromData()	0	8	2
B	buildModuleFromData()	0	11	6

<?php
namespace Samurai\Module;

use Samurai\Alias\Alias;

/**
 * Class Module
 * @package Samurai\module
 * @author Raphaël Lefebvre <raphael@raphaellefebvre.be>
 */
class Module extends Alias
{
    /**
     * @var bool
     */
    private $isEnable;

    /**
     * modules which must be executed before the current module.
     *
     * @var Modules
     */
    private $dependencies = [];

    /**
     * commands to run for the current module.
     *
     * @var array
     */
    private $tasks = [];

    /**
     * constructor
     */
    public function __construct()
    {
        $this->setDependencies(new Modules());
    }

    /**
     * Getter of $isEnable
     *
     * @return boolean
     */
    public function isEnable()
    {
        return $this->isEnable;
    }

    /**
     * Getter of $isEnable
     *
     * @return boolean
     */
    public function getIsEnable()
    {
        return $this->isEnable;
    }

    /**
     * Setter of $isEnable
     *
     * @param boolean $isEnable
     */
    public function setIsEnable($isEnable)
    {
        $this->isEnable = (boolean)$isEnable;
    }
    /**
     * Getter of $dependencyNames
     *
     * @return Modules
     */
    public function getDependencies()
    {
        return $this->dependencies;
    }

    /**
     * Setter of $dependencyNames
     *
     * @param Modules $dependencies
     */
    public function setDependencies($dependencies)
    {
        if(is_array($dependencies)){//todo should not be allowed + unit test with the ModuleManager!
            $dependencies = $this->buildModulesFromData($dependencies);
        }
        $this->dependencies = $dependencies;
    }

    /**
     * @param Modules $modules
     * @return Modules
     */
    public function retrieveDependents(Modules $modules)
    {
        $dependents = new Modules();
        /**
         * @var Module[] $modules
         */
        foreach($modules as $key => $module) {
            foreach($module->getDependencies() as $dependency){
                if($dependency->getPackage() === $this->getPackage()){
                    $dependents[$key] = $module;
                }
            }
        }
        return $dependents;
    }

    /**
     * Getter of $tasks
     *
     * @return array
     */
    public function getTasks()
    {
        return $this->tasks;
    }

    /**
     * Setter of $tasks
     *
     * @param array $tasks
     */
    public function setTasks(array $tasks)
    {
        $this->tasks = $tasks;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return array_merge(
            parent::toArray(),
            [
                'isEnable' => $this->isEnable(),
                'tasks' => $this->getTasks(),
                'dependencies' => $this->getDependencies()->toArray()
            ]
        );
    }

    /**
     * @param array $dependenciesData
     * @return Modules
     */
    private function buildModulesFromData(array $dependenciesData)
    {
        $modules = new Modules();
        foreach ($dependenciesData as $key => $dependencyData) {
            $modules[$key] = $this->buildModuleFromData($dependencyData);
        }
        return $modules;
    }

    /**
     * @param array $data
     * @return Module
     */
    private function buildModuleFromData(array $data)
    {
        $module = new Module();
        $module->setName(!empty($data['name']) ? $data['name'] : null);
        $module->setPackage(!empty($data['package']) ? $data['package'] : null);
        $module->setVersion(!empty($data['version']) ? $data['version'] : null);
        $module->setDescription(!empty($data['description']) ? $data['description'] : null);
        $module->setSource(!empty($data['source']) ? $data['source'] : null);
        $module->setIsEnable(true);
        return $module;
    }
}