Php::loadFile() - Code Metrics - xeriab/konfig - Measure and Improve Code Quality continuously with Scrutinizer

Php::loadFile() A
last analyzed 2016-11-04 20:18 UTC

↳ Parent: Php

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	6
ccs	0
cts	0
cp	0
rs	9.4285
cc	2
eloc	3
nc	2
nop	1
crap	6

<?php

/**
 * Konfig.
 *
 * Yet another simple configuration loader library.
 *
 * PHP version 5
 *
 * @category Library
 * @package  Konfig
 * @author   Xeriab Nabil (aka KodeBurner) <[email protected]>
 * @license  https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link     https://xeriab.github.io/projects/konfig
 */

namespace Exen\Konfig\FileParser;

use Exception;
use Exen\Konfig\Exception\ParseException;
use Exen\Konfig\Exception\UnsupportedFileFormatException;

/**
 * Konfig's PHP parser class.
 *
 * @category FileParser
 * @package  Konfig
 * @author   Xeriab Nabil (aka KodeBurner) <[email protected]>
 * @license  https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link     https://xeriab.github.io/projects/konfig
 *
 * @implements Exen\Konfig\FileParser\AbstractFileParser
 */
class Php extends AbstractFileParser
{
    /**
     * Loads a PHP file and gets its contents as an array.
     *
     * @param string $path File path
     *
     * @throws ParseException             If the PHP file throws an exception
     * @throws UnsupportedFormatException If the PHP file does not return an array
     *
     * @return array The parsed data
     *
     * @since 0.1.0
     */
    public function parse($path)
    {
        $data = null;

        // Require the file, if it throws an exception, rethrow it
        try {
            $data = $this->loadFile($path);
        } catch (Exception $ex) {
            throw new ParseException(
                [
                'message' => 'PHP file threw an exception',
                'file' => $path,
                'exception' => $ex,
                ]
            );
        }

        // If we have a callable, run it and expect an array back
        if (is_callable($data)) {
            $data = call_user_func($data);
        }

        // Check for array, if its anything else, throw an exception
        if (empty($data) || !is_array($data)) {
            throw new UnsupportedFileFormatException(
                'PHP file does not return an array'
            );
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     *
     * @return array Supported extensions
     *
     * @since 0.1.0
     */
    public function getSupportedFileExtensions()
    {
        return ['php', 'inc'];
    }

    /**
     * Loads in the given file and parses it.
     *
     * @param string|bool|null $file File to load
     *
     * @return array The parsed file data
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    protected function loadFile($file = null)
    {
        $this->file = is_file($file) ? $file : false;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return include $this->file;
    }

    /**
     * Returns the formatted configuration file contents.
     *
     * @param array $contents configuration array
     *
     * @return string formatted configuration file contents
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    protected function exportFormat($contents = null)
    {
        throw new Exception(
            'Saving configuration to `PHP` is not supported at this time'
        );
    }

    /**
     * __toString.
     *
     * @return             string
     * @since              0.1.2
     * @codeCoverageIgnore
     */
    public function __toString()
    {
        return 'Exen\Konfig\FileParser\Php' . PHP_EOL;
    }
}

// END OF ./src/FileParser/Php.php FILE


1		<?php
2
3		/**
4		* Konfig.
5		*
6		* Yet another simple configuration loader library.
7		*
8		* PHP version 5
9		*
10		* @category Library
11		* @package Konfig
12		* @author Xeriab Nabil (aka KodeBurner) <[email protected]>
13		* @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
14		* @link https://xeriab.github.io/projects/konfig
15		*/
16
17		namespace Exen\Konfig\FileParser;
18
19		use Exception;
20		use Exen\Konfig\Exception\ParseException;
21		use Exen\Konfig\Exception\UnsupportedFileFormatException;
22
23		/**
24		* Konfig's PHP parser class.
25		*
26		* @category FileParser
27		* @package Konfig
28		* @author Xeriab Nabil (aka KodeBurner) <[email protected]>
29		* @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
30		* @link https://xeriab.github.io/projects/konfig
31		*
32		* @implements Exen\Konfig\FileParser\AbstractFileParser
33		*/
34		class Php extends AbstractFileParser
35		{
36		/**
37		* Loads a PHP file and gets its contents as an array.
38		*
39		* @param string $path File path
40		*
41		* @throws ParseException If the PHP file throws an exception
42		* @throws UnsupportedFormatException If the PHP file does not return an array
43		*
44		* @return array The parsed data
45		*
46		* @since 0.1.0
47		*/
48	12	public function parse($path)
49		{
50	12	$data = null;
51
52		// Require the file, if it throws an exception, rethrow it
53		try {
54	12	$data = $this->loadFile($path);
55	6	} catch (Exception $ex) {
56	3	throw new ParseException(
57		[
58	3	'message' => 'PHP file threw an exception',
59	3	'file' => $path,
60	3	'exception' => $ex,
61		]
62	1	);
63		}
64
65		// If we have a callable, run it and expect an array back
66	9	if (is_callable($data)) {
67	3	$data = call_user_func($data);
68	1	}
69
70		// Check for array, if its anything else, throw an exception
71	9	if (empty($data) \|\| !is_array($data)) {
72	3	throw new UnsupportedFileFormatException(
73	2	'PHP file does not return an array'
74	1	);
75		}
76
77	6	return $data;
78		}
79
80		/**
81		* {@inheritdoc}
82		*
83		* @return array Supported extensions
84		*
85		* @since 0.1.0
86		*/
87	3	public function getSupportedFileExtensions()
88		{
89	3	return ['php', 'inc'];
90		}
91
92		/**
93		* Loads in the given file and parses it.
94		*
95		* @param string\|bool\|null $file File to load
96		*
97		* @return array The parsed file data
98		*
99		* @since 0.2.4
100		* @codeCoverageIgnore
101		*/
102		protected function loadFile($file = null)
103		{
104		$this->file = is_file($file) ? $file : false;
		0 ignored issues – show Documentation Bug introduced 2016-10-18 08:48 UTC by Report Bug Copy Issue Report It seems like `is_file($file) ? $file : false` can also be of type `boolean`. However, the property `$file` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
105
106		return include $this->file;
107		}
108
109		/**
110		* Returns the formatted configuration file contents.
111		*
112		* @param array $contents configuration array
113		*
114		* @return string formatted configuration file contents
115		*
116		* @since 0.2.4
117		* @codeCoverageIgnore
118		*/
119		protected function exportFormat($contents = null)
120		{
121		throw new Exception(
122		'Saving configuration to `PHP` is not supported at this time'
123		);
124		}
125
126		/**
127		* __toString.
128		*
129		* @return string
130		* @since 0.1.2
131		* @codeCoverageIgnore
132		*/
133		public function __toString()
134		{
135		return 'Exen\Konfig\FileParser\Php' . PHP_EOL;
136		}
137		}
138
139		// END OF ./src/FileParser/Php.php FILE
140

xeriab / konfig

Php::loadFile() A last analyzed 2016-11-04 20:18 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Php::loadFile() A
last analyzed 2016-11-04 20:18 UTC