functions.php ➔ xsitemap_xml_public() - Code Metrics - Inspection of "Updates for XOOPS 2.5.8, added new plugins, change..." - XoopsModules25x/xsitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

unknown

created 2017-05-03 02:48 UTC

functions.php ➔ xsitemap_xml_public() B

↳ Parent: Project

Complexity

Conditions	8
Paths	2

Size

Total Lines	60
Code Lines	34

Duplication

Lines	60
Ratio	100 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	8
eloc	34
c	2
b	0
f	1
nc	2
nop	0
dl	60
loc	60
rs	7.0677

How to fix Long Method

<?php

/*
 * ****************************************************************************
 * Module generated by TDMCreate from TDM "http://www.tdmxoops.net"
 * ****************************************************************************
 * xsitemap - MODULE FOR XOOPS CMS
 * Copyright (c) Urbanspaceman (http://www.takeaweb.it)
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * ****************************************************************************
 */
/**
 * Module: xsitemap
 *
 * @package      module\xsitemap\includes
 * @author       XOOPS Module Development Team
 * @author       http://www.takeaweb.it Urbanspaceman
 * @copyright    http://www.takeaweb.it Urbanspaceman
 * @copyright    http://xoops.org 2001-2017 XOOPS Project
 * @license      http://www.fsf.org/copyleft/gpl.html GNU public license
 * @link         http://xoops.org XOOPS
 * @since        1.00
 */

defined('XOOPS_ROOT_PATH') || exit('Restricted access');

xoops_loadLanguage('admin', 'xsitemap');
if (!class_exists('XsitemapDummyObject')) {
    xoops_load('dummy', 'xsitemap');
}
 /**
  *
  * Show Site map
  *
  * @return array
  */
function xsitemap_generate_sitemap()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    $block = array();
    $moduleDirName = $moduleDirName = basename(dirname(__DIR__));
    /** @internal can't use Helper since function called during install
    $xsitemapHelper = \Xmf\Module\Helper::getHelper($moduleDirName);
    $pluginHandler  = $xsitemapHelper->getHandler('plugin', $moduleDirName);
    */
    xoops_load('plugin', $moduleDirName);

    // Get list of modules admin wants to hide from xsitemap
    $invisibleDirnames = empty($GLOBALS['xoopsModuleConfig']['invisible_dirnames']) ? array('xsitemap') : explode(',', $GLOBALS['xoopsModuleConfig']['invisible_dirnames'] . ',xsitemap');
    $invisibleDirnames = array_map('trim', $invisibleDirnames);
    $invisibleDirnames = array_map('mb_strtolower', $invisibleDirnames);

    // Get the mid for any of these modules if they're active and hasmain (visible frontside)
    $moduleHandler = xoops_gethandler('module');
    $invisibleMidArray = array();
    foreach ($invisibleDirnames as $hiddenDir) {
        $criteria = new CriteriaCompo(new Criteria('hasmain', 1));
        $criteria->add(new Criteria('isactive', 1));
        $criteria->add(new Criteria('name', $hiddenDir));
        $modObj = $moduleHandler->getByDirname($hiddenDir);
        if (false !== $modObj && $modObj instanceof XoopsModule) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $invisibleMidArray[] = $modObj->mid();
        }
    }

    // Where user has permissions
    $modulepermHandler = xoops_gethandler('groupperm');
    $groups            = ($GLOBALS['xoopsUser'] instanceof XoopsUser) ? $GLOBALS['xoopsUser']->getGroups() : XOOPS_GROUP_ANONYMOUS;
if ($x instanceof DoesNotExist) {
    // Do something.
}
    $readAllowed       = $modulepermHandler->getItemIds('module_read', $groups);
    $filteredMids      = array_diff($readAllowed, $invisibleMidArray);
    $pluginHandler     = xoops_getModuleHandler('plugin', $moduleDirName);
    $criteria          = new CriteriaCompo(new Criteria('hasmain', 1));
    $criteria->add(new Criteria('isactive', 1));
    if (count($filteredMids) > 0) {
        $criteria->add(new Criteria('mid', '(' . implode(',', $filteredMids) . ')', 'IN'));
    }

    $modules = $moduleHandler->getObjects($criteria, true);

    $criteria = new CriteriaCompo();
    $criteria->setSort('plugin_id');
    $criteria->order = 'ASC';
    $pluginObjArray = $pluginHandler->getAll($criteria);

    foreach ($modules as $mid => $modObj) {
        $sublinks   = $modObj->subLink();
        $modDirName = $modObj->getVar('dirname', 'n');
        $block['modules'][$mid] = array('id' => $mid,
                                      'name' => $modObj->getVar('name'),
                                 'directory' => $modDirName,
                                  'sublinks' => array() // init the sublinks array
        );
        // Now 'patch' the sublink to include module path
        if (count($sublinks) > 0) {
            foreach ($sublinks as $sublink) {
                $block['modules'][$mid]['sublinks'][] = array('name' => $sublink['name'],
                                                               'url' => $GLOBALS['xoops']->url("www/modules/{$modDirName}/{$sublink['url']}"));
            }
        }

        foreach ($pluginObjArray as $pObj) {
            if ((0 == $pObj->getVar('topic_pid')) && in_array($pObj->getVar('plugin_mod_table'), (array) $modObj->getInfo('tables'))) {
                $objVars = $pObj->getValues();
                if (1 == $objVars['plugin_online']) {
                    $tmpMap = xsitemap_get_map($objVars['plugin_mod_table'], $objVars['plugin_cat_id'], $objVars['plugin_cat_pid'], $objVars['plugin_cat_name'], $objVars['plugin_call'], $objVars['plugin_weight']);
                    $block['modules'][$mid]['parent'] = isset($tmpMap['parent']) ? $tmpMap['parent'] : null;
                }
            }
        }
    }

    return $block;
}

/**
 * Get the Sitemap
 *
 * @return array sitemap links
 */
function xsitemap_get_map($table, $id_name, $pid_name, $title_name, $url, $order = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    $xDB  = XoopsDatabaseFactory::getDatabaseConnection();
    $myts = MyTextSanitizer::getInstance();

    $sql = "SELECT `{$id_name}`, `{$pid_name}`, `{$title_name}` FROM " . $xDB->prefix . "_{$table}" ;
    $result = $xDB->query($sql);
    $objsArray = array();

    while ($row = $xDB->fetchArray($result)) {
        $objsArray[] = new XsitemapDummyObject($row, $id_name, $pid_name, $title_name);
    }

    //$sql = "SELECT `{$id_name}`, `{$title_name}` FROM " . $xDB->prefix . "_{$table} WHERE `{$pid_name}`= 0";

    // v1.54 added in the event categories are flat (don't support hierarchy)
    $sql = "SELECT `{$id_name}`, `{$title_name}` FROM " . $xDB->prefix . "_{$table}";
    if ($pid_name !== $id_name) {
        $sql .= " WHERE `{$pid_name}`= 0";
    }
    if ('' != $order) {
        $sql .= " ORDER BY `{$order}`" ;
    }
    $result = $xDB->query($sql);

    $i = 0;
    $xsitemap = array();
    while (list($catid, $name) = $xDB->fetchRow($result)) {
        $xsitemap['parent'][$i] = array('id' => $catid,
                                     'title' => $myts->htmlSpecialChars($name),
                                       'url' => $url.$catid
        );

        if ($GLOBALS['xoopsModuleConfig']['show_subcategories'] && ($pid_name !== $id_name)) {
            $j = 0;
            $mytree = new XoopsObjectTree($objsArray, $id_name, $pid_name);
            $child_array = $mytree->getAllChild($catid);
            foreach ($child_array as $child) {
                $xsitemap['parent'][$i]['child'][$j] = array('id' => $child->getVar($id_name),
                                                          'title' => $child->getVar($title_name),
                                                            'url' => $url.$child->getVar($id_name)
                );
                ++$j;
            }
        }
        ++$i;
    }

    return $xsitemap;
}

/**
 * Save the XML Sitemap
 *
 * @return mixed int number of bytes saved | false on failure
 */
function xsitemap_save(array $xsitemap_show)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    $xml = new DOMDocument("1.0", "UTF-8");
    $xml->preserveWhiteSpace = false;
    $xml->formatOutput       = true;
    $xml_set = $xml->createElement('urlset');
    $xml_set->setAttribute('xmlns', "http://www.sitemaps.org/schemas/sitemap/0.9");

    if (!empty($xsitemap_show)) {
        foreach ($xsitemap_show['modules'] as $mod) {
            if ($mod["directory"]) {
                $xml_url = $xml->createElement("url");
                $xml_url->appendChild($xml->createComment(htmlentities(ucwords($mod['name']))));
//                $xml_url->appendChild($xml->createTextNode("<!-- ". htmlentities(ucwords($mod['name'])) . " -->"));

                $loc     = $xml->createElement('loc', htmlentities($GLOBALS['xoops']->url("www/modules/{$mod['directory']}/index.php")));
                $xml_url->appendChild($loc);
            }
            if (isset($mod['parent']) ? $mod['parent'] : null) {
                foreach ($mod["parent"] as $parent) {

                    $xml_parent = $xml->createElement("url");
                    $loc        = $xml->createElement('loc', htmlentities($GLOBALS['xoops']->url("www/modules/{$mod['directory']}/{$parent['url']}")));
                    $xml_parent->appendChild($loc);
                    $xml_url->appendChild($xml_parent);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                }
                $z = 0;
                //if ($mod["parent"][$z]["child"]) {

                if (isset($mod["parent"][$z]["child"]) ? $mod["parent"][$z]["child"] : null) {
                    foreach ($mod["parent"][$z]["child"] as $child) {

                        $xml_child = $xml->createElement("url");
                        $loc     = $xml->createElement('loc', htmlentities($GLOBALS['xoops']->url("www/modules/{$mod['directory']}/{$child['url']}")));
                        $xml_child->appendChild($loc);
                        $xml_url->appendChild($xml_child);
                    }
                    ++$z;
                }
            }
            $xml_set->appendChild($xml_url);
        }
    }
    $xml->appendChild($xml_set);
    return $xml->save($GLOBALS['xoops']->path("www/xsitemap.xml"));
}


Pull Request — master (#3)

functions.php ➔ xsitemap_xml_public() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Available Fixes

1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-06-04 07:56 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 42 and the first side effect is on line 30. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		/*
3		* ****************************************************************************
4		* Module generated by TDMCreate from TDM "http://www.tdmxoops.net"
5		* ****************************************************************************
6		* xsitemap - MODULE FOR XOOPS CMS
7		* Copyright (c) Urbanspaceman (http://www.takeaweb.it)
8		*
9		* You may not change or alter any portion of this comment or credits
10		* of supporting developers from this source code or any supporting source code
11		* which is considered copyrighted (c) material of the original comment or credit authors.
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15		* ****************************************************************************
16		*/
17		/**
18		* Module: xsitemap
19		*
20		* @package module\xsitemap\includes
21		* @author XOOPS Module Development Team
22		* @author http://www.takeaweb.it Urbanspaceman
23		* @copyright http://www.takeaweb.it Urbanspaceman
24		* @copyright http://xoops.org 2001-2017 XOOPS Project
25		* @license http://www.fsf.org/copyleft/gpl.html GNU public license
26		* @link http://xoops.org XOOPS
27		* @since 1.00
28		*/
29
30		defined('XOOPS_ROOT_PATH') \|\| exit('Restricted access');
31
32		xoops_loadLanguage('admin', 'xsitemap');
33		if (!class_exists('XsitemapDummyObject')) {
34		xoops_load('dummy', 'xsitemap');
35		}
36		/**
37		*
38		* Show Site map
39		*
40		* @return array
41		*/
42		function xsitemap_generate_sitemap()
		0 ignored issues – show Coding Style introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report `xsitemap_generate_sitemap` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
43		{
44		$block = array();
45		$moduleDirName = $moduleDirName = basename(dirname(__DIR__));
46		/** @internal can't use Helper since function called during install
47		$xsitemapHelper = \Xmf\Module\Helper::getHelper($moduleDirName);
48		$pluginHandler = $xsitemapHelper->getHandler('plugin', $moduleDirName);
49		*/
50		xoops_load('plugin', $moduleDirName);
51
52		// Get list of modules admin wants to hide from xsitemap
53		$invisibleDirnames = empty($GLOBALS['xoopsModuleConfig']['invisible_dirnames']) ? array('xsitemap') : explode(',', $GLOBALS['xoopsModuleConfig']['invisible_dirnames'] . ',xsitemap');
54		$invisibleDirnames = array_map('trim', $invisibleDirnames);
55		$invisibleDirnames = array_map('mb_strtolower', $invisibleDirnames);
56
57		// Get the mid for any of these modules if they're active and hasmain (visible frontside)
58		$moduleHandler = xoops_gethandler('module');
59		$invisibleMidArray = array();
60		foreach ($invisibleDirnames as $hiddenDir) {
61		$criteria = new CriteriaCompo(new Criteria('hasmain', 1));
62		$criteria->add(new Criteria('isactive', 1));
63		$criteria->add(new Criteria('name', $hiddenDir));
64		$modObj = $moduleHandler->getByDirname($hiddenDir);
65		if (false !== $modObj && $modObj instanceof XoopsModule) {
		0 ignored issues – show Bug introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report The class `XoopsModule` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
66		$invisibleMidArray[] = $modObj->mid();
67		}
68		}
69
70		// Where user has permissions
71		$modulepermHandler = xoops_gethandler('groupperm');
72		$groups = ($GLOBALS['xoopsUser'] instanceof XoopsUser) ? $GLOBALS['xoopsUser']->getGroups() : XOOPS_GROUP_ANONYMOUS;
		0 ignored issues – show Bug introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
73		$readAllowed = $modulepermHandler->getItemIds('module_read', $groups);
74		$filteredMids = array_diff($readAllowed, $invisibleMidArray);
75		$pluginHandler = xoops_getModuleHandler('plugin', $moduleDirName);
76		$criteria = new CriteriaCompo(new Criteria('hasmain', 1));
77		$criteria->add(new Criteria('isactive', 1));
78		if (count($filteredMids) > 0) {
79		$criteria->add(new Criteria('mid', '(' . implode(',', $filteredMids) . ')', 'IN'));
80		}
81
82		$modules = $moduleHandler->getObjects($criteria, true);
83
84		$criteria = new CriteriaCompo();
85		$criteria->setSort('plugin_id');
86		$criteria->order = 'ASC';
87		$pluginObjArray = $pluginHandler->getAll($criteria);
88
89		foreach ($modules as $mid => $modObj) {
90		$sublinks = $modObj->subLink();
91		$modDirName = $modObj->getVar('dirname', 'n');
92		$block['modules'][$mid] = array('id' => $mid,
93		'name' => $modObj->getVar('name'),
94		'directory' => $modDirName,
95		'sublinks' => array() // init the sublinks array
96		);
97		// Now 'patch' the sublink to include module path
98		if (count($sublinks) > 0) {
99		foreach ($sublinks as $sublink) {
100		$block['modules'][$mid]['sublinks'][] = array('name' => $sublink['name'],
101		'url' => $GLOBALS['xoops']->url("www/modules/{$modDirName}/{$sublink['url']}"));
102		}
103		}
104
105		foreach ($pluginObjArray as $pObj) {
106		if ((0 == $pObj->getVar('topic_pid')) && in_array($pObj->getVar('plugin_mod_table'), (array) $modObj->getInfo('tables'))) {
107		$objVars = $pObj->getValues();
108		if (1 == $objVars['plugin_online']) {
109		$tmpMap = xsitemap_get_map($objVars['plugin_mod_table'], $objVars['plugin_cat_id'], $objVars['plugin_cat_pid'], $objVars['plugin_cat_name'], $objVars['plugin_call'], $objVars['plugin_weight']);
110		$block['modules'][$mid]['parent'] = isset($tmpMap['parent']) ? $tmpMap['parent'] : null;
111		}
112		}
113		}
114		}
115
116		return $block;
117		}
118
119		/**
120		* Get the Sitemap
121		*
122		* @return array sitemap links
123		*/
124		function xsitemap_get_map($table, $id_name, $pid_name, $title_name, $url, $order = '')
		0 ignored issues – show Coding Style introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report `xsitemap_get_map` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
125		{
126		$xDB = XoopsDatabaseFactory::getDatabaseConnection();
127		$myts = MyTextSanitizer::getInstance();
128
129		$sql = "SELECT `{$id_name}`, `{$pid_name}`, `{$title_name}` FROM " . $xDB->prefix . "_{$table}" ;
130		$result = $xDB->query($sql);
131		$objsArray = array();
132
133		while ($row = $xDB->fetchArray($result)) {
134		$objsArray[] = new XsitemapDummyObject($row, $id_name, $pid_name, $title_name);
135		}
136
137		//$sql = "SELECT `{$id_name}`, `{$title_name}` FROM " . $xDB->prefix . "_{$table} WHERE `{$pid_name}`= 0";
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
138		// v1.54 added in the event categories are flat (don't support hierarchy)
139		$sql = "SELECT `{$id_name}`, `{$title_name}` FROM " . $xDB->prefix . "_{$table}";
140		if ($pid_name !== $id_name) {
141		$sql .= " WHERE `{$pid_name}`= 0";
142		}
143		if ('' != $order) {
144		$sql .= " ORDER BY `{$order}`" ;
145		}
146		$result = $xDB->query($sql);
147
148		$i = 0;
149		$xsitemap = array();
150		while (list($catid, $name) = $xDB->fetchRow($result)) {
151		$xsitemap['parent'][$i] = array('id' => $catid,
152		'title' => $myts->htmlSpecialChars($name),
153		'url' => $url.$catid
154		);
155
156		if ($GLOBALS['xoopsModuleConfig']['show_subcategories'] && ($pid_name !== $id_name)) {
157		$j = 0;
158		$mytree = new XoopsObjectTree($objsArray, $id_name, $pid_name);
159		$child_array = $mytree->getAllChild($catid);
160		foreach ($child_array as $child) {
161		$xsitemap['parent'][$i]['child'][$j] = array('id' => $child->getVar($id_name),
162		'title' => $child->getVar($title_name),
163		'url' => $url.$child->getVar($id_name)
164		);
165		++$j;
166		}
167		}
168		++$i;
169		}
170
171		return $xsitemap;
172		}
173
174		/**
175		* Save the XML Sitemap
176		*
177		* @return mixed int number of bytes saved \| false on failure
178		*/
179		function xsitemap_save(array $xsitemap_show)
		0 ignored issues – show Coding Style introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report `xsitemap_save` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
180		{
181		$xml = new DOMDocument("1.0", "UTF-8");
182		$xml->preserveWhiteSpace = false;
183		$xml->formatOutput = true;
184		$xml_set = $xml->createElement('urlset');
185		$xml_set->setAttribute('xmlns', "http://www.sitemaps.org/schemas/sitemap/0.9");
186
187		if (!empty($xsitemap_show)) {
188		foreach ($xsitemap_show['modules'] as $mod) {
189		if ($mod["directory"]) {
190		$xml_url = $xml->createElement("url");
191		$xml_url->appendChild($xml->createComment(htmlentities(ucwords($mod['name']))));
192		// $xml_url->appendChild($xml->createTextNode("<!-- ". htmlentities(ucwords($mod['name'])) . " -->"));
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report `66%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
193		$loc = $xml->createElement('loc', htmlentities($GLOBALS['xoops']->url("www/modules/{$mod['directory']}/index.php")));
194		$xml_url->appendChild($loc);
195		}
196		if (isset($mod['parent']) ? $mod['parent'] : null) {
197	View Code Duplication	foreach ($mod["parent"] as $parent) {
		0 ignored issues – show Duplication introduced 2017-05-03 02:50 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...
198		$xml_parent = $xml->createElement("url");
199		$loc = $xml->createElement('loc', htmlentities($GLOBALS['xoops']->url("www/modules/{$mod['directory']}/{$parent['url']}")));
200		$xml_parent->appendChild($loc);
201		$xml_url->appendChild($xml_parent);
		0 ignored issues – show Bug introduced 2017-05-03 02:50 UTC by Report Bug Copy Issue Report The variable `$xml_url` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
202		}
203		$z = 0;
204		//if ($mod["parent"][$z]["child"]) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-04 07:56 UTC by Report Bug Copy Issue Report `88%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
205		if (isset($mod["parent"][$z]["child"]) ? $mod["parent"][$z]["child"] : null) {
206	View Code Duplication	foreach ($mod["parent"][$z]["child"] as $child) {
		0 ignored issues – show Duplication introduced 2017-05-03 02:50 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...
207		$xml_child = $xml->createElement("url");
208		$loc = $xml->createElement('loc', htmlentities($GLOBALS['xoops']->url("www/modules/{$mod['directory']}/{$child['url']}")));
209		$xml_child->appendChild($loc);
210		$xml_url->appendChild($xml_child);
211		}
212		++$z;
213		}
214		}
215		$xml_set->appendChild($xml_url);
216		}
217		}
218		$xml->appendChild($xml_set);
219		return $xml->save($GLOBALS['xoops']->path("www/xsitemap.xml"));
220		}
221

XoopsModules25x / xsitemap

Pull Request — master (#3)

functions.php ➔ xsitemap_xml_public() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Available Fixes

Duplication Side-by-Side

Filter issues like