Issues in SemanticBreadcrumbLinks.php - Fixed Issues - Inspection of "Support extension.json, SBL 2.0.0" - SemanticMediaWiki/SemanticBreadcrumbLinks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#52)

by mw

created 2018-09-22 16:21 UTC

SemanticBreadcrumbLinks.php (5 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

use SBL\HookRegistry;
use SBL\Options;
use SMW\ApplicationFactory;

/**
 * @see https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/
 *
 * @defgroup SBL Semantic Breadcrumb Links
 */
if ( !defined( 'MEDIAWIKI' ) ) {
	die( 'This file is part of the Semantic Breadcrumb Links extension. It is not a valid entry point.' );
}

if ( defined( 'SBL_VERSION' ) ) {
	// Do not initialize more than once.
	return 1;
}

SemanticBreadcrumbLinks::load();

/**
 * @codeCoverageIgnore
 */
class SemanticBreadcrumbLinks {

	/**
	 * @since 1.3
	 */
	public static function load() {
// 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 ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
			include_once __DIR__ . '/vendor/autoload.php';
		}

		// Load DefaultSettings
		require_once __DIR__ . '/DefaultSettings.php';

		// In case extension.json is being used, the succeeding steps will
		// be handled by the ExtensionRegistry
		self::initExtension();

		$GLOBALS['wgExtensionFunctions'][] = function() {
			self::onExtensionFunction();
		};
	}

	/**
	 * @since 1.3
	 */
	public static function initExtension() {
// 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);
    }
}

		define( 'SBL_VERSION', '1.5.0' );
		define( 'SBL_PROP_PARENTPAGE', 'Has parent page' );

		// Register the extension
		$GLOBALS['wgExtensionCredits']['semantic'][ ] = [
			'path'           => __FILE__,
			'name'           => 'Semantic Breadcrumb Links',
			'author'         => [ 'James Hong Kong' ],
			'url'            => 'https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/',
			'descriptionmsg' => 'sbl-desc',
			'version'        => SBL_VERSION,
			'license-name'   => 'GPL-2.0-or-later',
		];

		// Register message files
		$GLOBALS['wgMessagesDirs']['SemanticBreadcrumbLinks'] = __DIR__ . '/i18n';
		$GLOBALS['wgExtensionMessagesFiles']['SemanticBreadcrumbLinksMagic'] = __DIR__ . '/i18n/SemanticBreadcrumbLinks.magic.php';

		// Register resource files
		$GLOBALS['wgResourceModules']['ext.semanticbreadcrumblinks.styles'] = [
			'styles'  => 'res/sbl.styles.css',
			'localBasePath' => __DIR__ ,
			'remoteExtPath' => 'SemanticBreadcrumbLinks',
			'position' => 'top',
			'group'    => 'ext.smw',
			'targets' => [
				'mobile',
				'desktop'
			]
		];

		$GLOBALS['wgResourceModules']['ext.semanticbreadcrumblinks'] = [
			'scripts' => 'res/sbl.tooltip.js',
			'localBasePath' => __DIR__ ,
			'remoteExtPath' => 'SemanticBreadcrumbLinks',
			'position' => 'top',
			'group'    => 'ext.smw',
			'dependencies'  => [
				'ext.semanticbreadcrumblinks.styles',
				'onoi.qtip'
			],
			'targets' => [
				'mobile',
				'desktop'
			]
		];
	}

	/**
	 * @since 1.3
	 */
	public static function checkRequirements() {
// 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 ( version_compare( $GLOBALS[ 'wgVersion' ], '1.27', 'lt' ) ) {
			die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/">Semantic Breadcrumb Links</a> is only compatible with MediaWiki 1.27 or above. You need to upgrade MediaWiki first.' );

		}

		if ( !defined( 'SMW_VERSION' ) ) {
			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/">Semantic Breadcrumb Links</a> requires <a href="https://github.com/SemanticMediaWiki/SemanticMediaWiki/">Semantic MediaWiki</a>. Please enable or install the extension first.' );

		}
	}

	/**
	 * @since 1.3
	 */
	public static function onExtensionFunction() {

		// Check requirements after LocalSetting.php has been processed
		self::checkRequirements();

		// Default values are defined at this point to ensure
		// NS contants are specified prior
		$defaultPropertySearchPatternByNamespace = [
			NS_CATEGORY => [
				'_SUBC',
				'_SUBC',
				'_SUBC'
			],
			SMW_NS_PROPERTY => [
				'_SUBP',
				'_SUBP',
				'_SUBP'
			],
			NS_MAIN => [
				SBL_PROP_PARENTPAGE,
				SBL_PROP_PARENTPAGE,
				SBL_PROP_PARENTPAGE
			],
			NS_HELP => [
				SBL_PROP_PARENTPAGE,
				SBL_PROP_PARENTPAGE,
				SBL_PROP_PARENTPAGE
			]
		];

		$configuration = [
			'hideSubpageParent' => $GLOBALS['egSBLPageTitleToHideSubpageParent'],
			'breadcrumbTrailStyleClass' => $GLOBALS['egSBLBreadcrumbTrailStyleClass'],
			'breadcrumbDividerStyleClass' => $GLOBALS['egSBLBreadcrumbDividerStyleClass'],
			'tryToFindClosestDescendant' => $GLOBALS['egSBLTryToFindClosestDescendant'],
			'useSubpageFinderFallback' => $GLOBALS['egSBLUseSubpageFinderFallback'],
			'enabledSubpageParentAnnotation' => $GLOBALS['egSBLEnabledSubpageParentAnnotation'],
			'disableTranslationSubpageAnnotation' => $GLOBALS['egSBLDisableTranslationSubpageAnnotation'],
			'wgNamespacesWithSubpages' => $GLOBALS['wgNamespacesWithSubpages'],
			'propertySearchPatternByNamespace' => $GLOBALS['egSBLPropertySearchPatternByNamespace'] + $defaultPropertySearchPatternByNamespace
		];

		$hookRegistry = new HookRegistry(
			ApplicationFactory::getInstance()->getStore(),
			new Options( $configuration )
		);

		$hookRegistry->register();
	}

	/**
	 * @since 1.3
	 *
	 * @return string|null
	 */
	public static function getVersion() {
		return SBL_VERSION;
	}

}


1			<?php
2
3			use SBL\HookRegistry;
4			use SBL\Options;
5			use SMW\ApplicationFactory;
6
7			/**
8			* @see https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/
9			*
10			* @defgroup SBL Semantic Breadcrumb Links
11			*/
12			if ( !defined( 'MEDIAWIKI' ) ) {
13			die( 'This file is part of the Semantic Breadcrumb Links extension. It is not a valid entry point.' );
14			}
15
16			if ( defined( 'SBL_VERSION' ) ) {
17			// Do not initialize more than once.
18			return 1;
19			}
20
21			SemanticBreadcrumbLinks::load();
22
23			/**
24			* @codeCoverageIgnore
25			*/
26			class SemanticBreadcrumbLinks {
27
28			/**
29			* @since 1.3
30			*/
31			public static function load() {
			0 ignored issues – show Coding Style introduced 2017-03-25 01:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this `load` 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			if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
34			include_once __DIR__ . '/vendor/autoload.php';
35			}
36
37			// Load DefaultSettings
38			require_once __DIR__ . '/DefaultSettings.php';
39
40			// In case extension.json is being used, the succeeding steps will
41			// be handled by the ExtensionRegistry
42			self::initExtension();
43
44			$GLOBALS['wgExtensionFunctions'][] = function() {
45			self::onExtensionFunction();
46			};
47			}
48
49			/**
50			* @since 1.3
51			*/
52			public static function initExtension() {
			0 ignored issues – show Coding Style introduced 2016-06-22 03:34 UTC by Report Bug Copy Issue Report Show Similar Issues like this `initExtension` 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...
53
54			define( 'SBL_VERSION', '1.5.0' );
55			define( 'SBL_PROP_PARENTPAGE', 'Has parent page' );
56
57			// Register the extension
58			$GLOBALS['wgExtensionCredits']['semantic'][ ] = [
59			'path' => __FILE__,
60			'name' => 'Semantic Breadcrumb Links',
61			'author' => [ 'James Hong Kong' ],
62			'url' => 'https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/',
63			'descriptionmsg' => 'sbl-desc',
64			'version' => SBL_VERSION,
65			'license-name' => 'GPL-2.0-or-later',
66			];
67
68			// Register message files
69			$GLOBALS['wgMessagesDirs']['SemanticBreadcrumbLinks'] = __DIR__ . '/i18n';
70			$GLOBALS['wgExtensionMessagesFiles']['SemanticBreadcrumbLinksMagic'] = __DIR__ . '/i18n/SemanticBreadcrumbLinks.magic.php';
71
72			// Register resource files
73			$GLOBALS['wgResourceModules']['ext.semanticbreadcrumblinks.styles'] = [
74			'styles' => 'res/sbl.styles.css',
75			'localBasePath' => __DIR__ ,
76			'remoteExtPath' => 'SemanticBreadcrumbLinks',
77			'position' => 'top',
78			'group' => 'ext.smw',
79			'targets' => [
80			'mobile',
81			'desktop'
82			]
83			];
84
85			$GLOBALS['wgResourceModules']['ext.semanticbreadcrumblinks'] = [
86			'scripts' => 'res/sbl.tooltip.js',
87			'localBasePath' => __DIR__ ,
88			'remoteExtPath' => 'SemanticBreadcrumbLinks',
89			'position' => 'top',
90			'group' => 'ext.smw',
91			'dependencies' => [
92			'ext.semanticbreadcrumblinks.styles',
93			'onoi.qtip'
94			],
95			'targets' => [
96			'mobile',
97			'desktop'
98			]
99			];
100			}
101
102			/**
103			* @since 1.3
104			*/
105			public static function checkRequirements() {
			0 ignored issues – show Coding Style introduced 2017-03-25 01:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this `checkRequirements` 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...
106
107			if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.27', 'lt' ) ) {
108			die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/">Semantic Breadcrumb Links</a> is only compatible with MediaWiki 1.27 or above. You need to upgrade MediaWiki first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2017-03-25 01:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `checkRequirements()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
109			}
110
111			if ( !defined( 'SMW_VERSION' ) ) {
112			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticBreadcrumbLinks/">Semantic Breadcrumb Links</a> requires <a href="https://github.com/SemanticMediaWiki/SemanticMediaWiki/">Semantic MediaWiki</a>. Please enable or install the extension first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2017-03-25 01:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `checkRequirements()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
113			}
114			}
115
116			/**
117			* @since 1.3
118			*/
119			public static function onExtensionFunction() {
120
121			// Check requirements after LocalSetting.php has been processed
122			self::checkRequirements();
123
124			// Default values are defined at this point to ensure
125			// NS contants are specified prior
126			$defaultPropertySearchPatternByNamespace = [
127			NS_CATEGORY => [
128			'_SUBC',
129			'_SUBC',
130			'_SUBC'
131			],
132			SMW_NS_PROPERTY => [
133			'_SUBP',
134			'_SUBP',
135			'_SUBP'
136			],
137			NS_MAIN => [
138			SBL_PROP_PARENTPAGE,
139			SBL_PROP_PARENTPAGE,
140			SBL_PROP_PARENTPAGE
141			],
142			NS_HELP => [
143			SBL_PROP_PARENTPAGE,
144			SBL_PROP_PARENTPAGE,
145			SBL_PROP_PARENTPAGE
146			]
147			];
148
149			$configuration = [
150			'hideSubpageParent' => $GLOBALS['egSBLPageTitleToHideSubpageParent'],
151			'breadcrumbTrailStyleClass' => $GLOBALS['egSBLBreadcrumbTrailStyleClass'],
152			'breadcrumbDividerStyleClass' => $GLOBALS['egSBLBreadcrumbDividerStyleClass'],
153			'tryToFindClosestDescendant' => $GLOBALS['egSBLTryToFindClosestDescendant'],
154			'useSubpageFinderFallback' => $GLOBALS['egSBLUseSubpageFinderFallback'],
155			'enabledSubpageParentAnnotation' => $GLOBALS['egSBLEnabledSubpageParentAnnotation'],
156			'disableTranslationSubpageAnnotation' => $GLOBALS['egSBLDisableTranslationSubpageAnnotation'],
157			'wgNamespacesWithSubpages' => $GLOBALS['wgNamespacesWithSubpages'],
158			'propertySearchPatternByNamespace' => $GLOBALS['egSBLPropertySearchPatternByNamespace'] + $defaultPropertySearchPatternByNamespace
159			];
160
161			$hookRegistry = new HookRegistry(
162			ApplicationFactory::getInstance()->getStore(),
163			new Options( $configuration )
164			);
165
166			$hookRegistry->register();
167			}
168
169			/**
170			* @since 1.3
171			*
172			* @return string\|null
173			*/
174			public static function getVersion() {
175			return SBL_VERSION;
176			}
177
178			}
179

SemanticMediaWiki / SemanticBreadcrumbLinks

Pull Request — master (#52)

SemanticBreadcrumbLinks.php (5 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like