WebpageXML::__construct() - Code Metrics - XoopsModules25x/xoopsinfo - Measure and Improve Code Quality continuously with Scrutinizer

WebpageXML::__construct() A
last analyzed 2017-05-24 06:12 UTC

↳ Parent: WebpageXML

Complexity

Conditions	4
Paths	6

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	9
nc	6
nop	2
dl	0
loc	14
rs	9.2
c	0
b	0
f	0

<?php
/**
 * XML Generator class
 *
 * PHP version 5
 *
 * @category  PHP
 * @package   PSI_XML
 * @author    Michael Cramer <[email protected]>
 * @copyright 2009 phpSysInfo
 * @license   http://opensource.org/licenses/gpl-2.0.php GNU General Public License
 * @version   SVN: $Id: class.WebpageXML.inc.php 661 2012-08-27 11:26:39Z namiltd $
 * @link      http://phpsysinfo.sourceforge.net
 */
 /**
 * class for xml output
 *
 * @category  PHP
 * @package   PSI_XML
 * @author    Michael Cramer <[email protected]>
 * @copyright 2009 phpSysInfo
 * @license   http://opensource.org/licenses/gpl-2.0.php GNU General Public License
 * @version   Release: 3.0
 * @link      http://phpsysinfo.sourceforge.net
 */
class WebpageXML extends Output implements PSI_Interface_Output
namespace YourVendor;

class YourClass { }
{
    /**
     * xml object that holds the generated xml
     *
     * @var XML
     */
    private $_xml;

    /**
     * only plugin xml
     *
     * @var boolean
     */
    private $_pluginRequest = false;

    /**
     * complete xml
     *
     * @var boolean
     */
    private $_completeXML = false;

    /**
     * name of the plugin
     *
     * @var string
     */
    private $_pluginName = null;

    /**
     * generate the output
     *
     * @return void
     */
    private function _prepare()
    {
        if (!$this->_pluginRequest) {
            // Figure out which OS we are running on, and detect support
            if (!file_exists(APP_ROOT.'/includes/os/class.'.PSI_OS.'.inc.php')) {
                $this->error->addError("file_exists(class.".PSI_OS.".inc.php)", PSI_OS." is not currently supported");
            }

            // check if there is a valid sensor configuration in phpsysinfo.ini
            $foundsp = array();
            if (defined('PSI_SENSOR_PROGRAM') && is_string(PSI_SENSOR_PROGRAM)) {

                if (preg_match(ARRAY_EXP, PSI_SENSOR_PROGRAM)) {
                    $sensorprograms = eval(strtolower(PSI_SENSOR_PROGRAM));

                } else {
                    $sensorprograms = array(strtolower(PSI_SENSOR_PROGRAM));
                }
                foreach ($sensorprograms as $sensorprogram) {
                    if (!file_exists(APP_ROOT.'/includes/mb/class.'.$sensorprogram.'.inc.php')) {
                        $this->error->addError("file_exists(class.".htmlspecialchars($sensorprogram).".inc.php)", "specified sensor program is not supported");
                    } else {
                        $foundsp[] = $sensorprogram;
                    }
                }
            }

            /**
             * motherboard information
             *
             * @var serialized array
             */
            define('PSI_MBINFO', serialize($foundsp));

            // check if there is a valid ups configuration in phpsysinfo.ini
            $foundup = array();
            if (defined('PSI_UPS_PROGRAM') && is_string(PSI_UPS_PROGRAM)) {

                if (preg_match(ARRAY_EXP, PSI_UPS_PROGRAM)) {
                    $upsprograms = eval(strtolower(PSI_UPS_PROGRAM));

                } else {
                    $upsprograms = array(strtolower(PSI_UPS_PROGRAM));
                }
                foreach ($upsprograms as $upsprogram) {
                    if (!file_exists(APP_ROOT.'/includes/ups/class.'.$upsprogram.'.inc.php')) {
                        $this->error->addError("file_exists(class.".htmlspecialchars($upsprogram).".inc.php)", "specified UPS program is not supported");
                    } else {
                        $foundup[] = $upsprogram;
                    }
                }
            }
            /**
             * ups information
             *
             * @var serialized array
             */
            define('PSI_UPSINFO', serialize($foundup));

            // if there are errors stop executing the script until they are fixed
            if ($this->error->errorsExist()) {
                $this->error->errorsAsXML();
            }
        }

        // Create the XML
        if ($this->_pluginRequest) {
            $this->_xml = new XML(false, $this->_pluginName);
        } else {
            $this->_xml = new XML($this->_completeXML);
        }
    }

    /**
     * render the output
     *
     * @return void
     */
    public function run()
    {
        header("Cache-Control: no-cache, must-revalidate\n");
        header("Content-Type: text/xml\n\n");
        $xml = $this->_xml->getXml();
        echo $xml->asXML();
    }

    /**
     * get XML as pure string
     *
     * @return string

     */
    public function getXMLString()
    {
        $xml = $this->_xml->getXml();

        return $xml->asXML();
    }

    /**
     * set parameters for the XML generation process
     *
     * @param boolean $completeXML switch for complete xml with all plugins
     * @param string  $plugin      name of the plugin

     *
     * @return void

     */
    public function __construct($completeXML, $plugin = null)
    {
        parent::__construct();
        if ($completeXML) {
            $this->_completeXML = true;
        }
        if ($plugin) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            if (in_array(strtolower($plugin), CommonFunctions::getPlugins())) {
                $this->_pluginName = $plugin;
                $this->_pluginRequest = true;
            }
        }
        $this->_prepare();
    }
}


1		<?php
2		/**
3		* XML Generator class
4		*
5		* PHP version 5
6		*
7		* @category PHP
8		* @package PSI_XML
9		* @author Michael Cramer <[email protected]>
10		* @copyright 2009 phpSysInfo
11		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
12		* @version SVN: $Id: class.WebpageXML.inc.php 661 2012-08-27 11:26:39Z namiltd $
13		* @link http://phpsysinfo.sourceforge.net
14		*/
15		/**
16		* class for xml output
17		*
18		* @category PHP
19		* @package PSI_XML
20		* @author Michael Cramer <[email protected]>
21		* @copyright 2009 phpSysInfo
22		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
23		* @version Release: 3.0
24		* @link http://phpsysinfo.sourceforge.net
25		*/
26		class WebpageXML extends Output implements PSI_Interface_Output
		0 ignored issues – show Coding Style Compatibility introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
27		{
28		/**
29		* xml object that holds the generated xml
30		*
31		* @var XML
32		*/
33		private $_xml;
34
35		/**
36		* only plugin xml
37		*
38		* @var boolean
39		*/
40		private $_pluginRequest = false;
41
42		/**
43		* complete xml
44		*
45		* @var boolean
46		*/
47		private $_completeXML = false;
48
49		/**
50		* name of the plugin
51		*
52		* @var string
53		*/
54		private $_pluginName = null;
55
56		/**
57		* generate the output
58		*
59		* @return void
60		*/
61		private function _prepare()
62		{
63		if (!$this->_pluginRequest) {
64		// Figure out which OS we are running on, and detect support
65		if (!file_exists(APP_ROOT.'/includes/os/class.'.PSI_OS.'.inc.php')) {
66		$this->error->addError("file_exists(class.".PSI_OS.".inc.php)", PSI_OS." is not currently supported");
67		}
68
69		// check if there is a valid sensor configuration in phpsysinfo.ini
70		$foundsp = array();
71	View Code Duplication	if (defined('PSI_SENSOR_PROGRAM') && is_string(PSI_SENSOR_PROGRAM)) {
		0 ignored issues – show Duplication introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72		if (preg_match(ARRAY_EXP, PSI_SENSOR_PROGRAM)) {
73		$sensorprograms = eval(strtolower(PSI_SENSOR_PROGRAM));
		0 ignored issues – show Coding Style introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report It is generally not recommended to use `eval` unless absolutely required. On one hand, `eval` might be exploited by malicious users if they somehow manage to inject dynamic content. On the other hand, with the emergence of faster PHP runtimes like the HHVM, `eval` prevents some optimization that they perform. Loading history...
74		} else {
75		$sensorprograms = array(strtolower(PSI_SENSOR_PROGRAM));
76		}
77		foreach ($sensorprograms as $sensorprogram) {
78		if (!file_exists(APP_ROOT.'/includes/mb/class.'.$sensorprogram.'.inc.php')) {
79		$this->error->addError("file_exists(class.".htmlspecialchars($sensorprogram).".inc.php)", "specified sensor program is not supported");
80		} else {
81		$foundsp[] = $sensorprogram;
82		}
83		}
84		}
85
86		/**
87		* motherboard information
88		*
89		* @var serialized array
90		*/
91		define('PSI_MBINFO', serialize($foundsp));
92
93		// check if there is a valid ups configuration in phpsysinfo.ini
94		$foundup = array();
95	View Code Duplication	if (defined('PSI_UPS_PROGRAM') && is_string(PSI_UPS_PROGRAM)) {
		0 ignored issues – show Duplication introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
96		if (preg_match(ARRAY_EXP, PSI_UPS_PROGRAM)) {
97		$upsprograms = eval(strtolower(PSI_UPS_PROGRAM));
		0 ignored issues – show Coding Style introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report It is generally not recommended to use `eval` unless absolutely required. On one hand, `eval` might be exploited by malicious users if they somehow manage to inject dynamic content. On the other hand, with the emergence of faster PHP runtimes like the HHVM, `eval` prevents some optimization that they perform. Loading history...
98		} else {
99		$upsprograms = array(strtolower(PSI_UPS_PROGRAM));
100		}
101		foreach ($upsprograms as $upsprogram) {
102		if (!file_exists(APP_ROOT.'/includes/ups/class.'.$upsprogram.'.inc.php')) {
103		$this->error->addError("file_exists(class.".htmlspecialchars($upsprogram).".inc.php)", "specified UPS program is not supported");
104		} else {
105		$foundup[] = $upsprogram;
106		}
107		}
108		}
109		/**
110		* ups information
111		*
112		* @var serialized array
113		*/
114		define('PSI_UPSINFO', serialize($foundup));
115
116		// if there are errors stop executing the script until they are fixed
117		if ($this->error->errorsExist()) {
118		$this->error->errorsAsXML();
119		}
120		}
121
122		// Create the XML
123		if ($this->_pluginRequest) {
124		$this->_xml = new XML(false, $this->_pluginName);
125		} else {
126		$this->_xml = new XML($this->_completeXML);
127		}
128		}
129
130		/**
131		* render the output
132		*
133		* @return void
134		*/
135		public function run()
136		{
137		header("Cache-Control: no-cache, must-revalidate\n");
138		header("Content-Type: text/xml\n\n");
139		$xml = $this->_xml->getXml();
140		echo $xml->asXML();
141		}
142
143		/**
144		* get XML as pure string
145		*
146		* @return string
		0 ignored issues – show Documentation introduced 2016-07-02 12:09 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...
147		*/
148		public function getXMLString()
149		{
150		$xml = $this->_xml->getXml();
151
152		return $xml->asXML();
153		}
154
155		/**
156		* set parameters for the XML generation process
157		*
158		* @param boolean $completeXML switch for complete xml with all plugins
159		* @param string $plugin name of the plugin
		0 ignored issues – show Documentation introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report Should the type for parameter `$plugin` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
160		*
161		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-07-02 12:09 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...
162		*/
163		public function __construct($completeXML, $plugin = null)
164		{
165		parent::__construct();
166		if ($completeXML) {
167		$this->_completeXML = true;
168		}
169		if ($plugin) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-02 12:09 UTC by Report Bug Copy Issue Report The expression `$plugin` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
170		if (in_array(strtolower($plugin), CommonFunctions::getPlugins())) {
171		$this->_pluginName = $plugin;
172		$this->_pluginRequest = true;
173		}
174		}
175		$this->_prepare();
176		}
177		}
178

XoopsModules25x / xoopsinfo

WebpageXML::__construct() A last analyzed 2017-05-24 06:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WebpageXML::__construct() A
last analyzed 2017-05-24 06:12 UTC