Failed Conditions
Push — develop_3.0 ( 80553c...f9d8ad )
by Adrien
31:09
created

SettingsHelper::getActiveSheetName()   B

Complexity

Conditions 5
Paths 8

Size

Total Lines 24
Code Lines 13

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 11
CRAP Score 5.0144

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 24
ccs 11
cts 12
cp 0.9167
rs 8.5125
c 1
b 0
f 0
cc 5
eloc 13
nc 8
nop 1
crap 5.0144
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 30
    public function getActiveSheetName($filePath)
28
    {
29 30
        $xmlReader = new XMLReader();
30 30
        if ($xmlReader->openFileInZip($filePath, self::SETTINGS_XML_FILE_PATH) === false) {
31 19
            return null;
32
        }
33
34 11
        $activeSheetName = null;
35
36
        try {
37 11
            while ($xmlReader->readUntilNodeFound(self::XML_NODE_CONFIG_ITEM)) {
38 11
                if ($xmlReader->getAttribute(self::XML_ATTRIBUTE_CONFIG_NAME) === self::XML_ATTRIBUTE_VALUE_ACTIVE_TABLE) {
39 11
                    $activeSheetName = $xmlReader->readString();
40 11
                    break;
41
                }
42
            }
43
        } catch (XMLProcessingException $exception) {
44
            // do nothing
45
        }
46
47 11
        $xmlReader->close();
48
49 11
        return $activeSheetName;
50
    }
51
}
52