ConfigureTrait::configure() - Code Metrics - Inspection of "Adding utility getConfig() in trait." - canax/configure - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d84b70...dfc805 )

by Mikael

created 2017-08-10 15:16 UTC

ConfigureTrait::configure() B

↳ Parent: ConfigureTrait

Complexity

Conditions	6
Paths	8

Size

Total Lines	25
Code Lines	15

Duplication

Lines	14
Ratio	56 %

Code Coverage

Tests	15
CRAP Score	6.0585

Importance

Changes

Metric	Value
dl	14
loc	25
c	0
b	0
f	0
ccs	15
cts	17
cp	0.8824
rs	8.439
cc	6
eloc	15
nc	8
nop	1
crap	6.0585

<?php

namespace Anax\Configure;

/**
 * Trait implementing reading from config-file and storing options in
 * $this->config.
 */
trait ConfigureTrait
{
    /**
     * @var [] $config store the configuration in this array.

     */
    private $config = [];



    /**
     * Read configuration from file or array, if a file, first check in
     * ANAX_APP_PATH/config and then in ANAX_INSTALL_PATH/config.
     *
     * @param array|string $what is an array with key/value config options
     *                           or a file to be included which returns such
     *                           an array.
     *
     * @throws Exception when argument if not a file nor an array.
     *
     * @return self for chaining.
     */
    public function configure($what)
    {
        if (is_array($what)) {
            $this->config = $what;
            return $this;
        }

        if (defined("ANAX_APP_PATH")) {

            $path = ANAX_APP_PATH . "/config/$what";
            if (is_readable($path)) {
                $this->config = require $path;
                return $this;
            }
        }

        if (defined("ANAX_INSTALL_PATH")) {

            $path = ANAX_INSTALL_PATH . "/config/$what";
            if (is_readable($path)) {
                $this->config = require $path;
                return $this;
            }
        }

        throw new Exception("Configure item '$what' is not an array nor a readable file.");
    }



    /**
     * Helper function for reading values from the configuration.
     *
     * @param string $key     matching a key in the config array.
     * @param string $default value returned when config item is not found.
     *
     * @return mixed or null if key does not exists.
     */
    public function getConfig($key, $default = null)
    {
        return isset($this->config[$key])
            ? $this->config[$key]
            : $default;
    }
}


1			<?php
2
3			namespace Anax\Configure;
4
5			/**
6			* Trait implementing reading from config-file and storing options in
7			* $this->config.
8			*/
9			trait ConfigureTrait
10			{
11			/**
12			* @var [] $config store the configuration in this array.
			0 ignored issues – show Documentation introduced 2017-05-04 08:48 UTC by Report Bug Copy Issue Report The doc-type `[]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
13			*/
14			private $config = [];
15
16
17
18			/**
19			* Read configuration from file or array, if a file, first check in
20			* ANAX_APP_PATH/config and then in ANAX_INSTALL_PATH/config.
21			*
22			* @param array\|string $what is an array with key/value config options
23			* or a file to be included which returns such
24			* an array.
25			*
26			* @throws Exception when argument if not a file nor an array.
27			*
28			* @return self for chaining.
29			*/
30	4		public function configure($what)
31			{
32	4		if (is_array($what)) {
33	2		$this->config = $what;
34	2		return $this;
35			}
36
37	2	View Code Duplication	if (defined("ANAX_APP_PATH")) {
			0 ignored issues – show Duplication introduced 2017-05-04 08:48 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
38	2		$path = ANAX_APP_PATH . "/config/$what";
39	2		if (is_readable($path)) {
40	1		$this->config = require $path;
41	1		return $this;
42			}
43	1		}
44
45	1	View Code Duplication	if (defined("ANAX_INSTALL_PATH")) {
			0 ignored issues – show Duplication introduced 2017-05-04 08:48 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
46	1		$path = ANAX_INSTALL_PATH . "/config/$what";
47	1		if (is_readable($path)) {
48			$this->config = require $path;
49			return $this;
50			}
51	1		}
52
53	1		throw new Exception("Configure item '$what' is not an array nor a readable file.");
54			}
55
56
57
58			/**
59			* Helper function for reading values from the configuration.
60			*
61			* @param string $key matching a key in the config array.
62			* @param string $default value returned when config item is not found.
63			*
64			* @return mixed or null if key does not exists.
65			*/
66			public function getConfig($key, $default = null)
67			{
68			return isset($this->config[$key])
69			? $this->config[$key]
70			: $default;
71			}
72			}
73

canax / configure

Push — master ( d84b70...dfc805 )

ConfigureTrait::configure() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like