print.php ➔ PrintPage() - Code Metrics - Inspection of "Merge pull request #4 from mambax7/master" - XoopsModules25x/soapbox - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 937117...931dfe )

by Michael

created 2017-05-24 09:25 UTC

print.php ➔ PrintPage() B

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	78
Code Lines	47

Duplication

Lines	3
Ratio	3.85 %

Importance

Changes

Metric	Value
cc	2
eloc	47
nc	2
nop	1
dl	3
loc	78
rs	8.9019
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 *
 * Module: Soapbox
 * Version: v 1.5
 * Release Date: 23 August 2004
 * Author: hsalazar
 * Licence: GNU
 */

use Xmf\Request;

include __DIR__ . '/header.php';
global $moduleDirName;
function myFunction($a, $b) {
    // Do something
}
$moduleDirName = $myts->htmlSpecialChars(basename(__DIR__));
if ($moduleDirName !== 'soapbox' && $moduleDirName !== '' && !preg_match('/^(\D+)(\d*)$/', $moduleDirName)) {

    echo('invalid dirname: ' . htmlspecialchars($moduleDirName, ENT_QUOTES));
}

require_once XOOPS_ROOT_PATH . '/modules/' . $moduleDirName . '/include/cleantags.php';

$articleID = Request::getInt('$articleID', Request::getInt('$articleID', 0, 'POST'), 'GET');

if (0 === $articleID) {
    redirect_header('index.php');
}

/**
 * @param $articleID
 */
function PrintPage($articleID)
// 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);
    }
}
{
    global $moduleDirName;
function myFunction($a, $b) {
    // Do something
}
    global $xoopsConfig, $xoopsModule, $xoopsModuleConfig;
function myFunction($a, $b) {
    // Do something
}
    $myts      = MyTextSanitizer:: getInstance();
    $articleID = (int)$articleID;
    //get entry object
    $entrydataHandler = xoops_getModuleHandler('entryget', $moduleDirName);
    $_entryob         = $entrydataHandler->getArticleOnePermcheck($articleID, true, true);
    if (!is_object($_entryob)) {

        redirect_header(XOOPS_URL . '/modules/' . $moduleDirName . '/index.php', 1, 'Not Found');
    }
    //-------------------------------------
    $articles = $_entryob->toArray();
    //get category object
    $_categoryob = $_entryob->_sbcolumns;
    //get vars
    $category = $_categoryob->toArray();
    //-------------------------------------
    //get author
    $authorname = SoapboxUtility::getAuthorName($category['author']);
    //-------------------------------------

    $datetime = $myts->htmlSpecialChars(formatTimestamp($articles['datesub'], $xoopsModuleConfig['dateformat']));
    //    $lead = $myts->htmlSpecialChars($lead);

    //    $bodytext = str_replace("[pagebreak]","<br style=\"page-break-after:always;\">",$bodytext);

    //    $bodytext = $myts->displayTarea($bodytext, $html, $smiley, $xcodes, '', $breaks);

    $bodytext = str_replace('[pagebreak]', '<br style="page-break-after:always;">', $_entryob->getVar('bodytext', 'none'));
    $bodytext = $GLOBALS['SoapboxCleantags']->cleanTags($myts->displayTarea($bodytext, $articles['html'], $articles['smiley'], $articles['xcodes'], '', $articles['breaks']));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

    $sitename = $myts->htmlSpecialChars($xoopsConfig['sitename']);
    $slogan   = $myts->htmlSpecialChars($xoopsConfig['slogan']);

    echo "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>\n";
    echo "<html>\n<head>\n";
    echo '<title>' . $sitename . "</title>\n";
    echo "<meta http-equiv='Content-Type' content='text/html; charset=" . _CHARSET . "' />\n";
    echo "<meta name='AUTHOR' content='" . $sitename . "' />\n";
    echo "<meta name='COPYRIGHT' content='Copyright (c) 2004 by " . $sitename . "' />\n";
    echo "<meta name='DESCRIPTION' content='" . $slogan . "' />\n";
    echo "<meta name='GENERATOR' content='" . XOOPS_VERSION . "' />\n\n\n";

    //hack start 2003-3-18 by toshimitsu
    //Column: --> _MD_SOAPBOX_COLUMNPRN , Author: --> _MD_SOAPBOX_AUTHORPRN
    echo "<body bgcolor='#ffffff' text='#000000'>
            <div style='width: 600px; border: 1px solid #000; padding: 20px;'>
                <div style='text-align: center; display: block; padding-bottom: 12px; margin: 0 0 6px 0; border-bottom: 2px solid #ccc;'><img src='"
         . XOOPS_URL
         . '/modules/'
         . $xoopsModule->dirname()
         . "/assets/images/sb_slogo.png' border='0' alt='' /><h2 style='margin: 0;'>"
         . $articles['headline']
         . '</h2></div>
                <div></div>
                <div>'
         . _MD_SOAPBOX_COLUMNPRN
         . '<b>'
         . $category['name']
         . "</b></div>
                <div style='padding-bottom: 6px; border-bottom: 1px solid #ccc;'>"
         . _MD_SOAPBOX_AUTHORPRN
         . ' <b>'
         . $authorname
         . '</b></div>
                <p>'
         . $articles['lead']
         . '</p>
                <p>'
         . $articles['bodytext']
         . "</p>
                <div style='padding-top: 12px; border-top: 2px solid #ccc;'><small><b>Published: </b>&nbsp;"
         . $datetime
         . '<br></div>
            </div>
            <br>
          </body>
          </html>';
}

PrintPage($articleID);


Push — master ( 937117...931dfe )

print.php ➔ PrintPage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-05-24 09:27 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 31 and the first side effect is on line 13. 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: Soapbox
5		* Version: v 1.5
6		* Release Date: 23 August 2004
7		* Author: hsalazar
8		* Licence: GNU
9		*/
10
11		use Xmf\Request;
12
13		include __DIR__ . '/header.php';
14		global $moduleDirName;
		0 ignored issues – show Compatibility Best Practice introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
15		$moduleDirName = $myts->htmlSpecialChars(basename(__DIR__));
16	View Code Duplication	if ($moduleDirName !== 'soapbox' && $moduleDirName !== '' && !preg_match('/^(\D+)(\d*)$/', $moduleDirName)) {
		0 ignored issues – show Duplication introduced 2017-05-20 10:35 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...
17		echo('invalid dirname: ' . htmlspecialchars($moduleDirName, ENT_QUOTES));
18		}
19
20		require_once XOOPS_ROOT_PATH . '/modules/' . $moduleDirName . '/include/cleantags.php';
21
22		$articleID = Request::getInt('$articleID', Request::getInt('$articleID', 0, 'POST'), 'GET');
23
24		if (0 === $articleID) {
25		redirect_header('index.php');
26		}
27
28		/**
29		* @param $articleID
30		*/
31		function PrintPage($articleID)
		0 ignored issues – show Coding Style introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report `PrintPage` 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...
32		{
33		global $moduleDirName;
		0 ignored issues – show Compatibility Best Practice introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
34		global $xoopsConfig, $xoopsModule, $xoopsModuleConfig;
		0 ignored issues – show Compatibility Best Practice introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
35		$myts = MyTextSanitizer:: getInstance();
36		$articleID = (int)$articleID;
37		//get entry object
38		$entrydataHandler = xoops_getModuleHandler('entryget', $moduleDirName);
39		$_entryob = $entrydataHandler->getArticleOnePermcheck($articleID, true, true);
40	View Code Duplication	if (!is_object($_entryob)) {
		0 ignored issues – show Duplication introduced 2017-05-20 10:35 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...
41		redirect_header(XOOPS_URL . '/modules/' . $moduleDirName . '/index.php', 1, 'Not Found');
42		}
43		//-------------------------------------
44		$articles = $_entryob->toArray();
45		//get category object
46		$_categoryob = $_entryob->_sbcolumns;
47		//get vars
48		$category = $_categoryob->toArray();
49		//-------------------------------------
50		//get author
51		$authorname = SoapboxUtility::getAuthorName($category['author']);
52		//-------------------------------------
53
54		$datetime = $myts->htmlSpecialChars(formatTimestamp($articles['datesub'], $xoopsModuleConfig['dateformat']));
55		// $lead = $myts->htmlSpecialChars($lead);
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report `59%` 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...
56		// $bodytext = str_replace("[pagebreak]","<br style=\"page-break-after:always;\">",$bodytext);
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report `53%` 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...
57		// $bodytext = $myts->displayTarea($bodytext, $html, $smiley, $xcodes, '', $breaks);
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report `63%` 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...
58		$bodytext = str_replace('[pagebreak]', '<br style="page-break-after:always;">', $_entryob->getVar('bodytext', 'none'));
59		$bodytext = $GLOBALS['SoapboxCleantags']->cleanTags($myts->displayTarea($bodytext, $articles['html'], $articles['smiley'], $articles['xcodes'], '', $articles['breaks']));
		0 ignored issues – show Unused Code introduced 2017-05-20 10:35 UTC by Report Bug Copy Issue Report `$bodytext` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
60
61		$sitename = $myts->htmlSpecialChars($xoopsConfig['sitename']);
62		$slogan = $myts->htmlSpecialChars($xoopsConfig['slogan']);
63
64		echo "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>\n";
65		echo "<html>\n<head>\n";
66		echo '<title>' . $sitename . "</title>\n";
67		echo "<meta http-equiv='Content-Type' content='text/html; charset=" . _CHARSET . "' />\n";
68		echo "<meta name='AUTHOR' content='" . $sitename . "' />\n";
69		echo "<meta name='COPYRIGHT' content='Copyright (c) 2004 by " . $sitename . "' />\n";
70		echo "<meta name='DESCRIPTION' content='" . $slogan . "' />\n";
71		echo "<meta name='GENERATOR' content='" . XOOPS_VERSION . "' />\n\n\n";
72
73		//hack start 2003-3-18 by toshimitsu
74		//Column: --> _MD_SOAPBOX_COLUMNPRN , Author: --> _MD_SOAPBOX_AUTHORPRN
75		echo "<body bgcolor='#ffffff' text='#000000'>
76		<div style='width: 600px; border: 1px solid #000; padding: 20px;'>
77		<div style='text-align: center; display: block; padding-bottom: 12px; margin: 0 0 6px 0; border-bottom: 2px solid #ccc;'><img src='"
78		. XOOPS_URL
79		. '/modules/'
80		. $xoopsModule->dirname()
81		. "/assets/images/sb_slogo.png' border='0' alt='' /><h2 style='margin: 0;'>"
82		. $articles['headline']
83		. '</h2></div>
84		<div></div>
85		<div>'
86		. _MD_SOAPBOX_COLUMNPRN
87		. '<b>'
88		. $category['name']
89		. "</b></div>
90		<div style='padding-bottom: 6px; border-bottom: 1px solid #ccc;'>"
91		. _MD_SOAPBOX_AUTHORPRN
92		. ' <b>'
93		. $authorname
94		. '</b></div>
95		<p>'
96		. $articles['lead']
97		. '</p>
98		<p>'
99		. $articles['bodytext']
100		. "</p>
101		<div style='padding-top: 12px; border-top: 2px solid #ccc;'><small><b>Published: </b> "
102		. $datetime
103		. '<br></div>
104		</div>
105		<br>
106		</body>
107		</html>';
108		}
109
110		PrintPage($articleID);
111

XoopsModules25x / soapbox

Push — master ( 937117...931dfe )

print.php ➔ PrintPage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like