iriven / ConfigManager

ConfigManager.php

<?php
namespace Iriven;

/**
 * Created by PhpStorm.
 * User: IRIVEN FRANCE
 * Date: 21/11/2015
 * Time: 10:44
 */
use Exception;

class ConfigManager
{
    /**
     * Chemin complet du fichier de configuration
     */
    private $targetFile;
    private $Options = [];
    /**
     * tableau multidimensionnel contenant les donnée de configuration, initialement
     * chargées depuis le fichier
     */
    private $Config = [];
    /**
     * processeurs de fichier pris en charge par l'application
     */
    private $availableDrivers = array('JSON', 'PHP','INI','YML');
    private $defaultSection = 'runtime';

    /**
     * ConfigManager constructor.
     * @param $filename
     * @param $location
     */
    public function __construct( $filename, $location=null )
    {
        $numargs = func_num_args();
        try
        {
            if($numargs > 2)
                throw new Exception('SETUP ERROR: configuration manager can accept only up to 2 parameters,'.$numargs.' given!');
            $this->configureOptions($filename,$location);
            $this->parseConfiguration($this->Options);
        }
        catch(Exception $a)
        {
            trigger_error($a->getMessage(),E_USER_ERROR);
        }
        return $this;
    }

    /**
     * @param null $section

Are you sure the doc-type for parameter $section is correct as it would always require null to be passed?

     * @param null $item

Are you sure the doc-type for parameter $item is correct as it would always require null to be passed?

     * @return array|bool|mixed
     */
    public function get($section=null, $item=null)
    {
        if($item) $item = trim(strtolower($item));
        if($section) $section = trim(strtolower($section));
        if(!count($this->Config)) return false;
        if(!$section or !strlen($section)) return $this->Config;
        if($section AND $item)
        {
            if(!isset($this->Config[$section]))
            {
                $key = $item;
                $item = $section;
                $section = $this->defaultSection;
                if(!isset($this->Config[$section][$item][$key]))
                    return false;
                return $this->Config[$section][$item][$key];
            }
        }
        elseif(!$item or !strlen($item))
        {
            $item = $section;
            if(isset($this->Config[$item])) return $this->Config[$item];
            $section = $this->defaultSection;
        }
        if(!isset($this->Config[$section][$item])) return false;
        return $this->Config[$section][$item];
    }
    /**
     * @param $section
     * @param $item
     * @param $value
     * @return bool
     */
    public function set($section,$item=null,$value=null)
    {
        ob_start();
        $numarg = func_num_args();
        $arguments=func_get_args();
        switch($numarg)
        {
            case 1:
                if(!is_array($arguments[0])) return false;
                $item=array_change_key_case($arguments[0], CASE_LOWER); $section=null; $value=null;
                break;
            case 2:
                if(is_array($arguments[0])) return false;
                $_arg = strtolower(trim($arguments[0]));
                if(is_array($arguments[1])){ $section=$_arg; $item =array_change_key_case($arguments[1], CASE_LOWER);$value=null;}
                else {$item = $_arg;$value=$arguments[1];$section=null;}
                break;
            default:
                break;
        }
        $section = $section? trim(strtolower($section)) : $this->defaultSection;
        if(!is_array($item))
        {
            if(!$value) return false;
            $item=trim(strtolower($item));
            if(!isset($this->Config[$section][$item]) or !is_array($this->Config[$section][$item])):
                $this->Config[$section][$item]=$value;
            else:
                if(!is_array($value)) $value = array($value);
                $this->Config[$section][$item] = array_merge($this->Config[$section][$item],$value);
            endif;
        }
        else
        {
            if($value) return false;
            $item = array_change_key_case($item, CASE_LOWER);
            $sectionsize = count($this->Config[$section]);
            $itemsize = count($item);
            if($sectionsize)
            {
                if($itemsize=='1')
                {
                    if(isset($this->Config[$section][key($item)]))
                        $this->Config[$section][key($item)] = array_merge($this->Config[$section][key($item)],$item[key($item)]);
                    else if(!is_numeric(key($item))) $this->Config[$section][key($item)]=$item[key($item)];
                }
                else $this->Config[$section] = array_merge($this->Config[$section],$item);
            }
            else $this->Config[$section] = $item;
        }
        $re = $this->Save();
        ob_end_clean();
        return $re;
    }
    /**
     * @param $section
     * @param $item
     * @return bool
     */
    public function del($section, $item=null)
    {
        $section = trim(strtolower($section));
        if($item and strlen($item))
        {
            $item = trim(strtolower($item));
            if(!isset($this->Config[$section]))
            {
                $key = $item;
                $item = $section;
                $section = $this->defaultSection;
                if(isset($this->Config[$section][$item][$key]))
                {
                    $itemSize=count($this->Config[$section][$item]);
                    if($itemSize>1) unset($this->Config[$section][$item][$key]);
                    else unset($this->Config[$section]);
                }
            }
            else
            {
                $sectionSize=count($this->Config[$section]);
                if(isset($this->Config[$section][$item]))
                {
                    if($sectionSize>1) unset($this->Config[$section][$item]);
                    else unset($this->Config[$section]);
                }
            }
        }
        else
        {
            $item = $section;
            if(!isset($this->Config[$item]))
            {
                $section = $this->defaultSection;
                $defaultSectionSize = count($this->Config[$section]);
                if(isset($this->Config[$section][$item]))
                {
                    if($defaultSectionSize>1) unset($this->Config[$section][$item]);
                    else unset($this->Config[$section]);
                }
            }
            else unset($this->Config[$item]);
        }
        return $this->Save();
    }

    /**
     * @param $file
     * @param $location
     * @return array
     * @throws Exception
     */
    private function configureOptions($file,$location=null){
        if(!is_string($file) or ($location and !is_string($location)))
            throw new Exception('SETUP ERROR: configuration manager can accept string only parameters');
        $default=[
            'driver' => 'PHP',
            'filename' => null,
            'directory' => __DIR__,
        ];
        $Options = [];
        if($location)
            $Options['directory']=rtrim($this->normalize($location),DIRECTORY_SEPARATOR);
        else{
            if(basename($file)!==$file)
                $Options['directory']= rtrim($this->normalize(pathinfo($file,PATHINFO_DIRNAME)),DIRECTORY_SEPARATOR);
        }
        $Options['filename'] = basename($file);
        if(strpos($Options['filename'],'.')!==false)
            $Options['driver'] = strtoupper(pathinfo($Options['filename'], PATHINFO_EXTENSION));
        else
            $Options['filename']= $Options['filename'].'.'.strtolower($default['driver']);
        if(!in_array($Options['driver'],$this->availableDrivers))
            throw new Exception('ERROR: driver "'.$Options['driver'].'" not supported');
        $this->Options = array_merge($default,$Options);
        return $this->Options;
    }

    /**
     * @param $path
     * @param $relativeTo
     * @return bool|string
     */
    private function normalize($path, $relativeTo = null) {
        $path = rtrim(preg_replace('#[/\\\\]+#', DIRECTORY_SEPARATOR, $path), DIRECTORY_SEPARATOR);
        $isAbsolute = stripos(PHP_OS, 'win')===0 ? preg_match('/^[A-Za-z]+:/', $path): !strncmp($path, DIRECTORY_SEPARATOR, 1);
        if (!$isAbsolute)
        {
            if (!$relativeTo) $relativeTo = getcwd();
            $path = $relativeTo.DIRECTORY_SEPARATOR.$path;
        }
        if (is_link($path) and ($parentPath = realpath(dirname($path))))
            return $parentPath.DIRECTORY_SEPARATOR.$path;
        if ($realpath = realpath($path))  return $realpath;
        $parts = explode(DIRECTORY_SEPARATOR, trim($path, DIRECTORY_SEPARATOR));
        while (end($parts) !== false)
        {
            array_pop($parts);
            $attempt = stripos(PHP_OS, 'win')===0 ? implode(DIRECTORY_SEPARATOR, $parts): DIRECTORY_SEPARATOR.implode(DIRECTORY_SEPARATOR, $parts);
            if ($realpaths = realpath($attempt))
            {
                $path = $realpaths.substr($path, strlen($attempt));
                break;
            }
        }
        return $path;
    }

    /**
     * @param array $options
     * @return array|bool|mixed
     */
    
    private function parseConfiguration($options=[])
    {
        try
        {  $this->targetFile = $this->normalize($options['directory'].DIRECTORY_SEPARATOR.$options['filename']);
            if(!file_exists($this->targetFile))
                file_put_contents($this->targetFile,'',LOCK_EX);
            switch($this->Options['driver'])
            {
                case 'JSON':
                    if(!function_exists('json_decode')) 
                        throw new Exception('Error: The PHP-Json extension is missing');
                    $this->Config = unserialize(json_decode(file_get_contents($this->targetFile), true));
                    break;
                case 'INI':
                    $this->Config = parse_ini_file($this->targetFile, true);
                    break;
                case 'YML':
                    $ndocs=0;
                    if(!function_exists('yaml_parse_file'))
                        throw new Exception('Error: The PHP-Yaml extension is missing');
                    $this->Config = yaml_parse_file($this->targetFile,0,$ndocs);
                    break;
                default:
                    if(!$this->Config = include $this->targetFile) $this->Config = [];
                    break;
            }
        }
        catch(Exception $b)
        {
            trigger_error($b->getMessage(),E_USER_ERROR);
        }
        return $this->Config;
    }

    /**
     * @return bool
     */
    private function Save()
    {
        try {
            if( !is_writeable( $this->targetFile ) )
            {
                if(@chmod($this->targetFile,0775))
                    throw new Exception('Cant write to file: '.$this->targetFile);
            }
            $content = null;
            switch($this->Options['driver'])
            {
                case 'JSON':
                    if(!function_exists('json_encode'))
                        throw new Exception('Error: The PHP-Json extension is missing');
                    $content .= json_encode(serialize($this->Config));
                    break;
                case 'INI':
                    $content .= '; @file generator: Iriven France Php "'.get_class($this).'" Class'.PHP_EOL;
                    $content .= '; @Last Update: '.date('Y-m-d H:i:s').PHP_EOL;
                    $content .= PHP_EOL;
                    foreach($this->Config as $section => $array)
                    {
                        is_array($array) or $array = array($array);
                        $content .= '[' . $section . ']'.PHP_EOL;
                        foreach( $array as $key => $value )
                            $content .= $key.' = '.$value.PHP_EOL;
                        $content .= PHP_EOL;
                    }
                    break;
                case 'YML':
                    if(!function_exists('yaml_emit'))
                        throw new Exception('Error: The PHP-Yaml extension is missing');
                    $content .= yaml_emit ($this->Config, YAML_UTF8_ENCODING , YAML_LN_BREAK );
                    break;
                default:
                    $content .= '<?php'.PHP_EOL;
                    $content .= 'return ';
                    $content .= var_export($this->Config, true) . ';';
                    $content = preg_replace('/array\s+\(/', '[', $content);
                    $content = preg_replace('/,(\s+)\)/', '$1]', $content);
                    break;
            }
            file_put_contents($this->targetFile, $content, LOCK_EX);
            if(@chmod($this->targetFile,0644))
                throw new Exception('Cant write to file: '.$this->targetFile);
        }
        catch (Exception $e)
        {  trigger_error($e->getMessage(),E_USER_ERROR);}
        return true;
    }
    /**
     * fin de la classe
     */
}