Breadcrumb - Code Metrics - Inspection of "namespaces, category" - mambax7/randomquote - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 171474...8d265e )

by Michael

created 2018-01-01 13:50 UTC

Breadcrumb A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	47
rs	10
c	0
b	0
f	0
wmc	5
lcom	1
cbo	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	addLink()	7	1
A	render()	15	3

<?php namespace Xoopsmodules\randomquote\common;


/*
 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: randomquote
 *
 * @category        Module
 * @package         randomquote
 * @author          XOOPS Development Team <[email protected]> - <https://xoops.org>
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GPL 2.0 or later
 * @link            https://xoops.org/
 * @since           1.0.0
 */
/*

 * Example:
 * $breadcrumb = new PedigreeBreadcrumb();
 * $breadcrumb->addLink( 'bread 1', 'index1.php' );
 * $breadcrumb->addLink( 'bread 2', '' );
 * $breadcrumb->addLink( 'bread 3', 'index3.php' );
 * echo $breadcrumb->render();
 */

defined('XOOPS_ROOT_PATH') || exit('XOOPS Root Path not defined');

/**
 * Class Breadcrumb
 */
class Breadcrumb
{
    public  $dirname;
    private $bread = [];

    /**
     *
     */
    public function __construct()
    {
        $this->dirname = basename(dirname(__DIR__));
    }

    /**
     * Add link to breadcrumb
     *
     * @param string $title
     * @param string $link
     */
    public function addLink($title = '', $link = '')
    {
        $this->bread[] = [
            'link'  => $link,
            'title' => $title
        ];
    }

    /**
     * Render Pedigree BreadCrumb
     *
     */
    public function render()
// 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);
    }
}
    {
        if (!isset($GLOBALS['xoTheme']) || !is_object($GLOBALS['xoTheme'])) {
            require_once $GLOBALS['xoops']->path('class/theme.php');
            $GLOBALS['xoTheme'] = new \xos_opal_Theme();
        }

        require_once $GLOBALS['xoops']->path('class/template.php');
        $breadcrumbTpl = new \XoopsTpl();
        $breadcrumbTpl->assign('breadcrumb', $this->bread);
        $html = $breadcrumbTpl->fetch('db:' . $this->dirname . '_common_breadcrumb.tpl');
        unset($breadcrumbTpl);

        return $html;
    }
}


1			<?php namespace Xoopsmodules\randomquote\common;
			0 ignored issues – show Coding Style Compatibility introduced 2018-01-01 13:52 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 37 and the first side effect is on line 32. 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			You may not change or alter any portion of this comment or credits
5			of supporting developers from this source code or any supporting source code
6			which is considered copyrighted (c) material of the original comment or credit authors.
7
8			This program is distributed in the hope that it will be useful,
9			but WITHOUT ANY WARRANTY; without even the implied warranty of
10			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*/
12			/**
13			* Module: randomquote
14			*
15			* @category Module
16			* @package randomquote
17			* @author XOOPS Development Team <[email protected]> - <https://xoops.org>
18			* @copyright {@link https://xoops.org/ XOOPS Project}
19			* @license GPL 2.0 or later
20			* @link https://xoops.org/
21			* @since 1.0.0
22			*/
23			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-01 13:52 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...
24			* Example:
25			* $breadcrumb = new PedigreeBreadcrumb();
26			* $breadcrumb->addLink( 'bread 1', 'index1.php' );
27			* $breadcrumb->addLink( 'bread 2', '' );
28			* $breadcrumb->addLink( 'bread 3', 'index3.php' );
29			* echo $breadcrumb->render();
30			*/
31
32			defined('XOOPS_ROOT_PATH') \|\| exit('XOOPS Root Path not defined');
33
34			/**
35			* Class Breadcrumb
36			*/
37			class Breadcrumb
38			{
39			public $dirname;
40			private $bread = [];
41
42			/**
43			*
44			*/
45			public function __construct()
46			{
47			$this->dirname = basename(dirname(__DIR__));
48			}
49
50			/**
51			* Add link to breadcrumb
52			*
53			* @param string $title
54			* @param string $link
55			*/
56			public function addLink($title = '', $link = '')
57			{
58			$this->bread[] = [
59			'link' => $link,
60			'title' => $title
61			];
62			}
63
64			/**
65			* Render Pedigree BreadCrumb
66			*
67			*/
68			public function render()
			0 ignored issues – show Documentation introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history... Coding Style introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `render` 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...
69			{
70			if (!isset($GLOBALS['xoTheme']) \|\| !is_object($GLOBALS['xoTheme'])) {
71			require_once $GLOBALS['xoops']->path('class/theme.php');
72			$GLOBALS['xoTheme'] = new \xos_opal_Theme();
73			}
74
75			require_once $GLOBALS['xoops']->path('class/template.php');
76			$breadcrumbTpl = new \XoopsTpl();
77			$breadcrumbTpl->assign('breadcrumb', $this->bread);
78			$html = $breadcrumbTpl->fetch('db:' . $this->dirname . '_common_breadcrumb.tpl');
79			unset($breadcrumbTpl);
80
81			return $html;
82			}
83			}
84

mambax7 / randomquote

Push — master ( 171474...8d265e )

Breadcrumb A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like