Plugins

Complexity

Total Complexity

22

Size/Duplication

Total Lines	122
Duplicated Lines	17.21 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	7
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getPlugins()	0	12	3
B	filterPlugins()	0	15	5
A	filterPluginsByName()	0	9	3
A	getPluginsJS()	7	7	2
A	getPluginsCSS()	7	7	2
A	getPluginsTemplates()	7	7	2
A	getTemplates()	0	14	4

<?php

class Plugins {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

    private $globalPlugins;

    public function __construct($globalPlugins=array()) {
        $this->globalPlugins = $globalPlugins;
    }
    
    /**
     * Returns the plugin configurations found from plugin folders inside the plugins folder
     * @return array
     */
    private function getPlugins() 
    {
        $plugins = array();
        $pluginconfs = glob('plugins/*/plugin.json');
        foreach ($pluginconfs as $path) {
            $folder = explode('/', $path)[1];
            if (file_exists($path)) {
                $plugins[$folder] = json_decode(file_get_contents($path), true);
            }
        }
        return $plugins;
    }

    /**
     * Returns the plugin configurations found from plugin folders 
     * inside the plugins folder filtered by filetype.
     * @param string $type filetype e.g. 'css', 'js' or 'template'
     * @return array
     */
    private function filterPlugins($type) {
        $plugins = $this->getPlugins();
        $ret = array();
        if (!empty($plugins)) {
            foreach ($plugins as $name => $files) {
                if (isset($files[$type])) {
                    $ret[$name] = array();
                    foreach ($files[$type] as $file) {
                        array_push($ret[$name], 'plugins/' . $name . '/' . $file);
                    }
                }
            } 
        }
        return $ret;
    }

    /**
     * Returns the plugin configurations found from plugin folders 
     * inside the plugins folder filtered by plugin name (the folder name).
     * @param string $type filetype e.g. 'css', 'js' or 'template'
     * @param array $names the plugin name strings (foldernames) in an array 
     * @return array
     */
    private function filterPluginsByName($type, $names) {
        $files = $this->filterPlugins($type);
        foreach ($files as $plugin => $filelist) {
            if (!in_array($plugin, $names)) {
                unset($files[$plugin]);
            }
        }
        return $files;
    }

    /**
     * Returns an array of javascript filepaths
     * @param array $names the plugin name strings (foldernames) in an array 
     * @return array
     */
    public function getPluginsJS($names=null) {

This method seems to be duplicated in your project.

        if ($names) {
            $names = array_merge($this->globalPlugins, $names);
            return $this->filterPluginsByName('js', $names);
        }
        return $this->filterPluginsByName('js', $this->globalPlugins);
    }

    /**
     * Returns an array of css filepaths
     * @param array $names the plugin name strings (foldernames) in an array 
     * @return array
     */
    public function getPluginsCSS($names=null) {

This method seems to be duplicated in your project.

        if ($names) {
            $names = array_merge($this->globalPlugins, $names);
            return $this->filterPluginsByName('css', $names);
        }
        return $this->filterPluginsByName('css', $this->globalPlugins);
    }

    /**
     * Returns an array of template filepaths
     * @param array $names the plugin name strings (foldernames) in an array 
     * @return array
     */
    public function getPluginsTemplates($names=null) {

This method seems to be duplicated in your project.

        if ($names) {
            $names = array_merge($this->globalPlugins, $names);
            return $this->filterPluginsByName('templates', $names);
        }
        return $this->filterPluginsByName('templates', $this->globalPlugins);
    }

    /**
     * Returns an array of template files contents as strings
     * @param array $names the plugin name strings (foldernames) in an array 
     * @return array
     */
    public function getTemplates($names=null) {
        $templateStrings = array();
        $plugins = $this->getPluginsTemplates($names);
        foreach ($plugins as $folder => $templates) {
            foreach ($templates as $path) {
                if (file_exists($path)) {
                    $filename = explode('/', $path)[sizeof(explode('/', $path))-1];
                    $id = $folder . '-' . substr($filename, 0 , (strrpos($filename, ".")));
                    $templateStrings[$id] = file_get_contents($path);
                }
            }
        }
        return $templateStrings;
    }
}