XmlFile::open() - Code Metrics - fwk/Xml - Measure and Improve Code Quality continuously with Scrutinizer

XmlFile::open() B
last analyzed 2016-06-28 21:07 UTC

↳ Parent: XmlFile

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	4

Importance

Changes	6
Bugs	1	Features	1

Metric	Value
c	6
b	1
f	1
dl	0
loc	22
ccs	12
cts	12
cp	1
rs	8.9197
cc	4
eloc	12
nc	4
nop	0
crap	4

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2012, Julien Ballestracci <[email protected]>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 *
 * @category  XML
 * @package   Fwk\Xml
 * @author    Julien Ballestracci <[email protected]>
 * @copyright 2011-2014 Julien Ballestracci <[email protected]>
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://www.nitronet.org/fwk
 */
namespace Fwk\Xml;

use SimpleXMLElement;

/**
 * XmlFile
 *
 * Represents an existing XML file on filesystem. Uses SimpleXML.
 *
 * @category Library
 * @package  Fwk\Xml
 * @author   Julien Ballestracci <[email protected]>
 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link     http://www.nitronet.org/fwk
 */
class XmlFile
{
    /**
     * Path to XML file
     * @var string
     */
    protected $path;

    /**
     * Root SimpleXML node
     * @var SimpleXMLElement
     */
    protected $xml;

    /**
     * Constructor
     *
     * @param string $filePath Path to XML file
     *
     * @throws \InvalidArgumentException if path links to a directory
     * @return void

     */
    public function __construct($filePath)
    {
        if (is_dir($filePath)) {
            throw new \InvalidArgumentException(
                sprintf("File %s is a directory", $filePath)
            );
        }

        if (\function_exists('libxml_use_internal_errors')) {
            \libxml_use_internal_errors(true);
        }

        $this->path = $filePath;
    }

    /**
     * Tells if the file exists
     *
     * @return boolean
     */
    public function exists()
    {
        return is_file($this->getRealPath());
    }

    /**
     * Try to return the real path of the file. If not possible,
     * returns user-submitted path (@see __construct)
     *
     * @return string
     */
    public function getRealPath()
    {
        $rpt = \realpath($this->path);

        return ($rpt === false ? $this->path : $rpt);
    }

    /**
     * Tells if the file is readable
     *
     * @return boolean
     */
    public function isReadable()
    {
        return ($this->exists() ? is_readable($this->path) : false);
    }

    /**
     * Opens the XML file (if not already done) and return the SimpleXML root
     * node.
     *
     * @throws Exceptions\FileNotFoundException If file not found/readable
     * @throws Exceptions\XmlErrorException     If XML errors were found (libxml)
     * @return SimpleXMLElement
     */
    public function open()
    {
        if (!isset($this->xml)) {
            if (!$this->isReadable()) {
                throw new Exceptions\FileNotFoundException(
                    "XML file not found/readable: ". $this->path
                );
            }

            if (!$this->xml = simplexml_load_file($this->getRealPath())) {
                $error = sprintf(
                    "%s [%s]",
                    libxml_get_last_error()->message,
                    \libxml_get_last_error()->code
                );

                throw new Exceptions\XmlErrorException($error);
            }
        }

        return $this->xml;
    }

    /**
     * Returns the contents of the XML file
     *
     * @return string

     */
    public function __toString()
    {
        return $this->open()->asXML();
    }

    /**
     * SimpleXML wrapper to access XML nodes the simple way: $file->node->name
     *
     * @param string $var XML node name
     *
     * @return mixed
     */
    public function __get($var)
    {
        return $this->open()->{$var};
    }

    /**
     * SimpleXML wrapper to do a Xpath query on the file.
     *
     * @param string $path Path to XML node
     *
     * @return mixed
     */
    public function xpath($path)
    {
        return $this->open()->xpath($path);
    }
}

1		<?php
2		/**
3		* Fwk
4		*
5		* Copyright (c) 2011-2012, Julien Ballestracci <[email protected]>.
6		* All rights reserved.
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
12		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
13		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14		* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
15		* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
16		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
17		* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19		* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
21		* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22		* POSSIBILITY OF SUCH DAMAGE.
23		*
24		* PHP Version 5.3
25		*
26		* @category XML
27		* @package Fwk\Xml
28		* @author Julien Ballestracci <[email protected]>
29		* @copyright 2011-2014 Julien Ballestracci <[email protected]>
30		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
31		* @link http://www.nitronet.org/fwk
32		*/
33		namespace Fwk\Xml;
34
35		use SimpleXMLElement;
36
37		/**
38		* XmlFile
39		*
40		* Represents an existing XML file on filesystem. Uses SimpleXML.
41		*
42		* @category Library
43		* @package Fwk\Xml
44		* @author Julien Ballestracci <[email protected]>
45		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
46		* @link http://www.nitronet.org/fwk
47		*/
48		class XmlFile
49		{
50		/**
51		* Path to XML file
52		* @var string
53		*/
54		protected $path;
55
56		/**
57		* Root SimpleXML node
58		* @var SimpleXMLElement
59		*/
60		protected $xml;
61
62		/**
63		* Constructor
64		*
65		* @param string $filePath Path to XML file
66		*
67		* @throws \InvalidArgumentException if path links to a directory
68		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-06-28 20:44 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
69		*/
70	20	public function __construct($filePath)
71		{
72	20	if (is_dir($filePath)) {
73	1	throw new \InvalidArgumentException(
74	1	sprintf("File %s is a directory", $filePath)
75		);
76		}
77
78	20	if (\function_exists('libxml_use_internal_errors')) {
79	20	\libxml_use_internal_errors(true);
80		}
81
82	20	$this->path = $filePath;
83	20	}
84
85		/**
86		* Tells if the file exists
87		*
88		* @return boolean
89		*/
90	19	public function exists()
91		{
92	19	return is_file($this->getRealPath());
93		}
94
95		/**
96		* Try to return the real path of the file. If not possible,
97		* returns user-submitted path (@see __construct)
98		*
99		* @return string
100		*/
101	19	public function getRealPath()
102		{
103	19	$rpt = \realpath($this->path);
104
105	19	return ($rpt === false ? $this->path : $rpt);
106		}
107
108		/**
109		* Tells if the file is readable
110		*
111		* @return boolean
112		*/
113	16	public function isReadable()
114		{
115	16	return ($this->exists() ? is_readable($this->path) : false);
116		}
117
118		/**
119		* Opens the XML file (if not already done) and return the SimpleXML root
120		* node.
121		*
122		* @throws Exceptions\FileNotFoundException If file not found/readable
123		* @throws Exceptions\XmlErrorException If XML errors were found (libxml)
124		* @return SimpleXMLElement
125		*/
126	16	public function open()
127		{
128	16	if (!isset($this->xml)) {
129	16	if (!$this->isReadable()) {
130	1	throw new Exceptions\FileNotFoundException(
131	1	"XML file not found/readable: ". $this->path
132		);
133		}
134
135	15	if (!$this->xml = simplexml_load_file($this->getRealPath())) {
136	1	$error = sprintf(
137	1	"%s [%s]",
138	1	libxml_get_last_error()->message,
139	1	\libxml_get_last_error()->code
140		);
141
142	1	throw new Exceptions\XmlErrorException($error);
143		}
144		}
145
146	14	return $this->xml;
147		}
148
149		/**
150		* Returns the contents of the XML file
151		*
152		* @return string
		0 ignored issues – show Documentation introduced 2016-06-28 20:44 UTC by Report Bug Copy Issue Report Should the return type not be `string\|false`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
153		*/
154	1	public function __toString()
155		{
156	1	return $this->open()->asXML();
157		}
158
159		/**
160		* SimpleXML wrapper to access XML nodes the simple way: $file->node->name
161		*
162		* @param string $var XML node name
163		*
164		* @return mixed
165		*/
166	1	public function __get($var)
167		{
168	1	return $this->open()->{$var};
169		}
170
171		/**
172		* SimpleXML wrapper to do a Xpath query on the file.
173		*
174		* @param string $path Path to XML node
175		*
176		* @return mixed
177		*/
178	12	public function xpath($path)
179		{
180	12	return $this->open()->xpath($path);
181		}
182		}

fwk / Xml

XmlFile::open() B last analyzed 2016-06-28 21:07 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

XmlFile::open() B
last analyzed 2016-06-28 21:07 UTC