Exen\Konfig\FileParser\AbstractFileParser

Complexity

Total Complexity

15

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	1	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	load()	0	4	1
A	parse()	0	4	1
A	save()	0	4	1
A	group()	0	4	1
A	getSupportedFileExtensions()	0	4	1
A	findFile()	0	4	1
A	parseVars()	0	8	2
B	prepVars()	0	22	6
	loadFile()	0	1	?
	exportFormat()	0	1	?

<?php
/**
 * Konfig
 *
 * Yet another simple configuration file loader library.
 *
 * @author  Xeriab Nabil (aka KodeBurner) <kodeburner@gmail.com>
 * @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link    https://xeriab.github.io/projects/konfig
 */

namespace Exen\Konfig\FileParser;

class AbstractFileParser implements FileParserInterface

There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: exportFormat, loadFile

{
    /**
     * Configuration file
     *
     * @var string
     */
    protected $file = null;

    /**
     * The configuration variables
     *
     * @var array
     */
    protected $vars = [];

    /**
     * Sets up the file to be parsed and variables
     *
     * @param string $file Config file name
     * @param array $vars Variables to parse in the file
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($file = null, $vars = [])
    {
        $this->file = $file;

        $this->vars = [] + $vars;
    }

    public function load($overwrite = false, $cache = true)

The parameter $overwrite is not used and could be removed.

The parameter $cache is not used and could be removed.

    {
        // Nothing to put here!
    }

    public function parse($file)
    {
        // Nothing to put here!
    }

    public function save($contents)

The parameter $contents is not used and could be removed.

    {
        // Nothing to put here!
    }

    /**
     * Gets the default group name.
     *
     * @return string
     */
    public function group()
    {
        return $this->file;
    }

    public function getSupportedFileExtensions()
    {
        // Nothing to put here!
    }

    #: Protected Methods

    /**
     * Finds the given config files
     *
     * @param bool $cache
     * param bool $multiple Whether to load multiple files or not
     * @return array
     */
    protected function findFile($cache = true)

The parameter $cache is not used and could be removed.

    {
        // Nothing to put here!
    }

    /**
     * Parses a string using all of the previously set variables.
     * Allows you to use something like %ENV% in non-PHP files.
     *
     * @param string $string String to parse
     * @return string
     */
    protected function parseVars($string)
    {
        foreach ($this->vars as $var => $val) {
            $string = str_replace("%$var%", $val, $string);
        }

        return $string;
    }

    /**
     * Replaces given constants to their string counterparts.
     *
     * @param array $array Array to be prepped
     * @return array Prepped array
     */
    protected function prepVars(&$array)
    {
        static $replace = false;

        if ($replace === false) {
            foreach ($this->vars as $x => $v) {
                $replace['#^('.preg_quote($v).'){1}(.*)?#'] = '%'. $x .'%$2';
            }
        }

        foreach ($array as $x => $value) {
            if (is_string($value)) {
                $array[$x] = preg_replace(
                    array_keys($replace),
                    array_values($replace),
                    $value
                );
            } elseif (is_array($value)) {
                $this->prepVars($array[$x]);
            }
        }
    }

    #: Abstract Methods

    /**
     * Must be implemented by child class.
     * Gets called for each file to load.
     */
    abstract protected function loadFile($file);

    /**
     * Must be impletmented by child class.
     * Gets called when saving a configuration file.
     *
     * @param array $contents  config array to save
     * @return string formatted output
     */
    abstract protected function exportFormat($contents);
}

#: END OF ./src/FileParser/AbstractFileParser.php FILE