SettingsHelper::getActiveSheetName() - Code Metrics - Inspection of "Expose Sheet::isActive() to provide info about the..." - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a6546...7f8b95 )

by Adrien

created 2017-04-15 19:40 UTC

SettingsHelper::getActiveSheetName() B

↳ Parent: SettingsHelper

Complexity

Conditions	5
Paths	8

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	24
ccs	13
cts	13
cp	1
rs	8.5125
cc	5
eloc	13
nc	8
nop	1
crap	5

<?php

namespace Box\Spout\Reader\ODS\Helper;

use Box\Spout\Reader\Exception\XMLProcessingException;
use Box\Spout\Reader\Wrapper\XMLReader;

/**
 * Class SettingsHelper
 * This class provides helper functions to extract data from the "settings.xml" file.
 *
 * @package Box\Spout\Reader\ODS\Helper
 */
class SettingsHelper
{
    const SETTINGS_XML_FILE_PATH = 'settings.xml';

    /** Definition of XML nodes name and attribute used to parse settings data */
    const XML_NODE_CONFIG_ITEM = 'config:config-item';
    const XML_ATTRIBUTE_CONFIG_NAME = 'config:name';
    const XML_ATTRIBUTE_VALUE_ACTIVE_TABLE = 'ActiveTable';

    /**
     * @param string $filePath Path of the file to be read
     * @return string|null Name of the sheet that was defined as active or NULL if none found
     */
    public function getActiveSheetName($filePath)
    {
        $xmlReader = new XMLReader();
        if ($xmlReader->openFileInZip($filePath, self::SETTINGS_XML_FILE_PATH) === false) {
            return null;
        }

        $activeSheetName = null;

        try {
            while ($xmlReader->readUntilNodeFound(self::XML_NODE_CONFIG_ITEM)) {
                if ($xmlReader->getAttribute(self::XML_ATTRIBUTE_CONFIG_NAME) === self::XML_ATTRIBUTE_VALUE_ACTIVE_TABLE) {
                    $activeSheetName = $xmlReader->readString();
                    break;
                }
            }
        } catch (XMLProcessingException $exception) {
            // do nothing
        }

        $xmlReader->close();

        return $activeSheetName;
    }
}


1		<?php
2
3		namespace Box\Spout\Reader\ODS\Helper;
4
5		use Box\Spout\Reader\Exception\XMLProcessingException;
6		use Box\Spout\Reader\Wrapper\XMLReader;
7
8		/**
9		* Class SettingsHelper
10		* This class provides helper functions to extract data from the "settings.xml" file.
11		*
12		* @package Box\Spout\Reader\ODS\Helper
13		*/
14		class SettingsHelper
15		{
16		const SETTINGS_XML_FILE_PATH = 'settings.xml';
17
18		/** Definition of XML nodes name and attribute used to parse settings data */
19		const XML_NODE_CONFIG_ITEM = 'config:config-item';
20		const XML_ATTRIBUTE_CONFIG_NAME = 'config:name';
21		const XML_ATTRIBUTE_VALUE_ACTIVE_TABLE = 'ActiveTable';
22
23		/**
24		* @param string $filePath Path of the file to be read
25		* @return string\|null Name of the sheet that was defined as active or NULL if none found
26		*/
27	90	public function getActiveSheetName($filePath)
28		{
29	90	$xmlReader = new XMLReader();
30	90	if ($xmlReader->openFileInZip($filePath, self::SETTINGS_XML_FILE_PATH) === false) {
31	57	return null;
32		}
33
34	33	$activeSheetName = null;
35
36		try {
37	33	while ($xmlReader->readUntilNodeFound(self::XML_NODE_CONFIG_ITEM)) {
38	33	if ($xmlReader->getAttribute(self::XML_ATTRIBUTE_CONFIG_NAME) === self::XML_ATTRIBUTE_VALUE_ACTIVE_TABLE) {
39	33	$activeSheetName = $xmlReader->readString();
40	33	break;
41		}
42	33	}
43	33	} catch (XMLProcessingException $exception) {
44		// do nothing
45		}
46
47	33	$xmlReader->close();
48
49	33	return $activeSheetName;
50		}
51		}
52

box / spout

Push — master ( 4a6546...7f8b95 )

SettingsHelper::getActiveSheetName() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like