ConfigurationUtils::prepareErrorMessages() - Code Metrics - appserver-io/configuration - Measure and Improve Code Quality continuously with Scrutinizer

ConfigurationUtils::prepareErrorMessages() A
last analyzed 2018-04-23 18:37 UTC

↳ Parent: ConfigurationUtils

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2

Importance

Changes

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

<?php

/**
 * \AppserverIo\Configuration\ConfigurationUtils
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/configuration
 * @link       http://www.appserver.io
 */

namespace AppserverIo\Configuration;

/**
 * Configuration utility implementation.
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/configuration
 * @link       http://www.appserver.io
 */
class ConfigurationUtils
{

    /**
     * The instance.
     *
     * @var \AppserverIo\Configuration\ConfigurationUtils
     */
    protected static $instance;

    /**
     * Protected constructor to avoid direct instanciation.
     */
    protected function __construct()
    {
    }

    /**
     * Creates a singleton instance of the utility class.
     *
     * @return \AppserverIo\Configuration\ConfigurationUtils The singleton instance
     */
    public static function singleton()
    {

        // query whether we've already loaded an instance or not
        if (ConfigurationUtils::$instance == null) {
            ConfigurationUtils::$instance = new ConfigurationUtils();
        }

        // return the singleton instance
        return ConfigurationUtils::$instance;
    }

    /**
     * Will return recently found errors already formatted for output
     *
     * @param array $errors An array with error messages
     *
     * @return array The array with the formatted error messages
     */
    protected function prepareErrorMessages($errors)
    {
        $errorMessages = array();
        foreach ($errors as $error) {
            $errorMessages[] = sprintf(
                "Found a schema validation error on line %s with code %s and message %s when validating configuration file %s, see error dump below: %s",
                $error->line,
                $error->code,
                $error->message,
                $error->file,
                var_export($error, true)
            );
        }
        return $errorMessages;
    }

    /**
     * Will validate a given file against a schema. This method supports several validation
     * mechanisms for different file types. Will return TRUE if validation passes, FALSE
     * otherwise.
     *
     * @param string  $fileName     Name of the file to validate
     * @param string  $schemaFile   The specific schema file to validate against
     * @param boolean $failOnErrors If the validation should fail on error (optional)
     *
     * @return void
     *
     * @throws \AppserverIo\Configuration\ConfigurationException If aren't able to validate this file type
     */
    public function validateFile($fileName, $schemaFile, $failOnErrors = false)
    {

        // check by the files extension if we're able to validate the file
        switch ($extension = pathinfo($fileName, PATHINFO_EXTENSION)) {


            // in case we found a XML file
            case 'xml':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                // validate the DOM document instance
                $domDocument = new \DOMDocument();
                $domDocument->load($fileName);
                ConfigurationUtils::singleton()->validateXml($domDocument, $schemaFile, $failOnErrors);
                break;

            // in all other cases we throw an excption
            default:
switch ($expr) {
    default:
        doSomething(); //right
        break;
}


switch ($expr) {
    default:

        doSomething(); //wrong
        break;
}

                throw new ConfigurationException(
                    sprintf(
                        'Could not find a validation method for file %s as the extension %s is not supported.',
                        $fileName,
                        $extension
                    )
                );
                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }
    }

    /**
     * Will validate a DOM document against a schema file. Will return TRUE if validation
     * passes, FALSE otherwise.
     *
     * @param \DOMDocument $domDocument  DOM document to validate
     * @param string       $schemaFile   The specific schema file to validate against
     * @param boolean      $failOnErrors If the validation should fail on error (optional)
     *
     * @return void
     *
     * @throws \AppserverIo\Configuration\ConfigurationException If $failOnErrors is set to true an exception will be thrown on errors
     */
    public function validateXml(\DOMDocument $domDocument, $schemaFile, $failOnErrors = false)
    {

        // activate internal error handling, necessary to catch errors with libxml_get_errors()
        libxml_use_internal_errors(true);

        // prepare result and error messages
        $errorMessages = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // validate the configuration file with the schema
        if ($domDocument->schemaValidate($schemaFile) === false) {
            // collect the errors and return as a failure
            $errorMessages = ConfigurationUtils::singleton()->prepareErrorMessages(libxml_get_errors());

            // if we have to fail on errors we might do so here
            if ($failOnErrors === true) {
                throw new ConfigurationException(reset($errorMessages));
            }
        }
    }
}


1		<?php
2
3		/**
4		* \AppserverIo\Configuration\ConfigurationUtils
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Tim Wagner <[email protected]>
15		* @copyright 2015 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link http://github.com/appserver-io/configuration
18		* @link http://www.appserver.io
19		*/
20
21		namespace AppserverIo\Configuration;
22
23		/**
24		* Configuration utility implementation.
25		*
26		* @author Tim Wagner <[email protected]>
27		* @copyright 2015 TechDivision GmbH <[email protected]>
28		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
29		* @link http://github.com/appserver-io/configuration
30		* @link http://www.appserver.io
31		*/
32		class ConfigurationUtils
33		{
34
35		/**
36		* The instance.
37		*
38		* @var \AppserverIo\Configuration\ConfigurationUtils
39		*/
40		protected static $instance;
41
42		/**
43		* Protected constructor to avoid direct instanciation.
44		*/
45	1	protected function __construct()
46		{
47	1	}
48
49		/**
50		* Creates a singleton instance of the utility class.
51		*
52		* @return \AppserverIo\Configuration\ConfigurationUtils The singleton instance
53		*/
54	3	public static function singleton()
55		{
56
57		// query whether we've already loaded an instance or not
58	3	if (ConfigurationUtils::$instance == null) {
59	1	ConfigurationUtils::$instance = new ConfigurationUtils();
60		}
61
62		// return the singleton instance
63	3	return ConfigurationUtils::$instance;
64		}
65
66		/**
67		* Will return recently found errors already formatted for output
68		*
69		* @param array $errors An array with error messages
70		*
71		* @return array The array with the formatted error messages
72		*/
73	1	protected function prepareErrorMessages($errors)
74		{
75	1	$errorMessages = array();
76	1	foreach ($errors as $error) {
77	1	$errorMessages[] = sprintf(
78	1	"Found a schema validation error on line %s with code %s and message %s when validating configuration file %s, see error dump below: %s",
79	1	$error->line,
80	1	$error->code,
81	1	$error->message,
82	1	$error->file,
83	1	var_export($error, true)
84		);
85		}
86	1	return $errorMessages;
87		}
88
89		/**
90		* Will validate a given file against a schema. This method supports several validation
91		* mechanisms for different file types. Will return TRUE if validation passes, FALSE
92		* otherwise.
93		*
94		* @param string $fileName Name of the file to validate
95		* @param string $schemaFile The specific schema file to validate against
96		* @param boolean $failOnErrors If the validation should fail on error (optional)
97		*
98		* @return void
99		*
100		* @throws \AppserverIo\Configuration\ConfigurationException If aren't able to validate this file type
101		*/
102	3	public function validateFile($fileName, $schemaFile, $failOnErrors = false)
103		{
104
105		// check by the files extension if we're able to validate the file
106	3	switch ($extension = pathinfo($fileName, PATHINFO_EXTENSION)) {
		0 ignored issues – show Coding Style introduced 2018-04-23 18:37 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
107
108		// in case we found a XML file
109	3	case 'xml':
		0 ignored issues – show Coding Style introduced 2018-04-23 18:37 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
110
111		// validate the DOM document instance
112	2	$domDocument = new \DOMDocument();
113	2	$domDocument->load($fileName);
114	2	ConfigurationUtils::singleton()->validateXml($domDocument, $schemaFile, $failOnErrors);
115	1	break;
116
117		// in all other cases we throw an excption
118		default:
		0 ignored issues – show Coding Style introduced 2018-04-23 18:37 UTC by Report Bug Copy Issue Report The default body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a default statement must start on the line immediately following the statement. switch ($expr) { default: doSomething(); //right break; } switch ($expr) { default: doSomething(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
119
120	1	throw new ConfigurationException(
121	1	sprintf(
122	1	'Could not find a validation method for file %s as the extension %s is not supported.',
123	1	$fileName,
124	1	$extension
125		)
126		);
127		break;
		0 ignored issues – show Unused Code introduced 2016-02-20 13:11 UTC by Report Bug Copy Issue Report `break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
128		}
129	1	}
130
131		/**
132		* Will validate a DOM document against a schema file. Will return TRUE if validation
133		* passes, FALSE otherwise.
134		*
135		* @param \DOMDocument $domDocument DOM document to validate
136		* @param string $schemaFile The specific schema file to validate against
137		* @param boolean $failOnErrors If the validation should fail on error (optional)
138		*
139		* @return void
140		*
141		* @throws \AppserverIo\Configuration\ConfigurationException If $failOnErrors is set to true an exception will be thrown on errors
142		*/
143	2	public function validateXml(\DOMDocument $domDocument, $schemaFile, $failOnErrors = false)
144		{
145
146		// activate internal error handling, necessary to catch errors with libxml_get_errors()
147	2	libxml_use_internal_errors(true);
148
149		// prepare result and error messages
150	2	$errorMessages = array();
		0 ignored issues – show Unused Code introduced 2016-02-20 13:11 UTC by Report Bug Copy Issue Report `$errorMessages` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
151
152		// validate the configuration file with the schema
153	2	if ($domDocument->schemaValidate($schemaFile) === false) {
154		// collect the errors and return as a failure
155	1	$errorMessages = ConfigurationUtils::singleton()->prepareErrorMessages(libxml_get_errors());
156
157		// if we have to fail on errors we might do so here
158	1	if ($failOnErrors === true) {
159	1	throw new ConfigurationException(reset($errorMessages));
160		}
161		}
162	1	}
163		}
164

appserver-io / configuration

ConfigurationUtils::prepareErrorMessages() A last analyzed 2018-04-23 18:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ConfigurationUtils::prepareErrorMessages() A
last analyzed 2018-04-23 18:37 UTC