Nymfonya\Component\Interfaces\IConfig

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	setEnv()	0	1	?
	getEnv()	0	1	?
	setPath()	0	1	?
	getPath()	0	1	?
	getSettings()	0	1	?
	hasEntry()	0	1	?
	load()	0	1	?

<?php

/**
 * Nymfonya\Component\Config\Interfaces\IConfig
 *
 * @author pierrefromager
 */

namespace Nymfonya\Component\Interfaces;

use Nymfonya\Component\Config;

interface IConfig

IConfig does not seem to conform to the naming convention (^[A-Z][a-zA-Z0-9]*Interface$).

{
    const CONFIG_REL_PATH = '../config/';
    const CONFIG_ERROR_MISSING = 'Missing config env for ';
    const ENV_DEV = 'dev';
    const ENV_TEST = 'test';
    const ENV_INT = 'int';
    const ENV_PROD = 'prod';
    const ENV_CLI = 'cli';
    const _MIDDLEWARES = 'middlewares';
    const _LOGGER = 'logger';
    const _NAME = 'name';
    const _PATH = 'path';
    const _ROUTES = 'routes';
    const _SERVICES = 'services';
    const _ACCOUNTS = 'accounts';
    const _DB = 'db';

    /**
     * set config environment
     *
     * @param string $env
     * @return Config
     */
    public function setEnv(string $env = self::ENV_DEV): Config;

    /**
     * returns env
     *
     * @return string
     */
    public function getEnv(): string;

    /**
     * set config path
     *
     * @param string $path
     * @return Config
     */
    public function setPath(string $path): Config;

    /**
     * returns config path
     *
     * @return string
     */
    public function getPath(): string;

    /**
     * return config array for a main entry key
     *
     * @param string $key
     * @return array
     */
    public function getSettings(string $key = ''): array;

    /**
     * return true if config main entry for a key exists
     *
     * @param string $key
     * @return boolean
     */
    public function hasEntry(string $key): bool;

    /**
     * load config for a given env
     *
     * @return Config
     */
    public function load(): Config;
}