Flynt\BuildConstructionPlan

Complexity

Total Complexity

23

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	fromConfig()	0	10	1
A	fromConfigRecursive()	0	21	2
A	fromConfigFile()	0	10	2
A	validateConfig()	0	27	5
A	overwriteParentData()	0	10	3
A	addCustomData()	0	11	3
A	applyDataModifications()	0	16	1
A	addSubcomponents()	0	29	4
A	mapAreaComponents()	0	7	2

<?php

namespace Flynt;

class BuildConstructionPlan
{
    public static function fromConfig($config)
    {
        do_action('Flynt/beforeBuildConstructionPlan', $config);

        $constructionPlan = self::fromConfigRecursive($config);

        do_action('Flynt/afterBuildConstructionPlan', $constructionPlan);

        return $constructionPlan;
    }

    protected static function fromConfigRecursive($config, $parentData = [])
    {
        // Check configuration for errors
        if (false === self::validateConfig($config)) {
            return [];
        }

        $config['data'] = [];

        // check for parent data overwrite
        $parentData = self::overwriteParentData($config, $parentData);

        // add data to component
        $config = self::addCustomData($config);

        // apply addComponentData filters to be used in a functions.php of a component for example
        $config = self::applyDataModifications($config, $parentData);

        // add subcomponents (dynamic + static) and return construction plan for the current component
        return self::addSubcomponents($config, $parentData);
    }

    public static function fromConfigFile($configFileName)
    {
        $configFilePath = apply_filters('Flynt/configPath', null, $configFileName);
        if (!is_file($configFilePath)) {
            trigger_error('Config file not found: ' . $configFilePath, E_USER_WARNING);
            return [];
        }
        $config = apply_filters('Flynt/configFileLoader', null, $configFileName, $configFilePath);
        return self::fromConfig($config);
    }

    protected static function validateConfig($config)
    {
        if (!is_array($config)) {
            trigger_error('Config needs to be an array! ' . gettype($config) . ' given.', E_USER_WARNING);
            return false;
        }
        if (empty($config)) {
            trigger_error('Config is empty!', E_USER_WARNING);
            return false;
        }
        if (!array_key_exists('name', $config)) {
            trigger_error(
                'No component name given! Please make sure every component has at least a \'name\' attribute.',
                E_USER_WARNING
            );
            return false;
        }
        // check if this component is registered
        $componentManager = ComponentManager::getInstance();
        if (false === $componentManager->isRegistered($config['name'])) {
            trigger_error(
                "Component '{$config['name']}' could not be found in component list. Did you forget to register the component?",
                E_USER_WARNING
            );
            return false;
        }
    }

    protected static function overwriteParentData(&$config, $parentData)
    {
        if (array_key_exists('parentData', $config)) {
            if (is_array($config['parentData'])) {
                $parentData = $config['parentData'];
            }
            unset($config['parentData']);
        }
        return $parentData;
    }

    protected static function addCustomData($config)
    {
        if (array_key_exists('customData', $config)) {
            if (is_array($config['customData'])) {
                // custom data overwrites original data
                $config['data'] = array_merge($config['data'], $config['customData']);
            }
            unset($config['customData']);
        }
        return $config;
    }

    protected static function applyDataModifications($config, $parentData)
    {
        $config['data'] = apply_filters(
            'Flynt/addComponentData',
            $config['data'],
            $parentData,
            $config
        );
        $config['data'] = apply_filters(
            "Flynt/addComponentData?name={$config['name']}",
            $config['data'],
            $parentData,
            $config
        );
        return $config;
    }

    protected static function addSubcomponents($config, $parentData)
    {
        // add dynamic subcomponents to areas
        $areas = array_key_exists('areas', $config) ? $config['areas'] : [];
        $config['areas'] = apply_filters(
            "Flynt/dynamicSubcomponents?name={$config['name']}",
            $areas,
            $config['data'],
            $parentData
        );

        // iterate areas and recursively map child component construction plan
        if (!empty($config['areas'])) {
            $areaNames = array_keys($config['areas']);
            $config['areas'] = array_reduce($areaNames, function ($output, $areaName) use ($config, $parentData) {
                $components = $config['areas'][$areaName];
                $output[$areaName] = array_filter(self::mapAreaComponents($components, $config, $areaName, $parentData));
                return $output;
            }, []);
        }

        // remove empty 'areas' key from config
        // this can happen if there were no areas defined to begin with
        if (empty($config['areas'])) {
            unset($config['areas']);
        }

        return $config;
    }

    protected static function mapAreaComponents($components, $config, $areaName, $parentData)
    {
        return array_map(function ($component) use ($config, $areaName, $parentData) {
            $data = empty($config['data']) ? $parentData : $config['data'];
            return self::fromConfigRecursive($component, $data);
        }, $components);
    }
}