Issues in SemanticScribunto.php - Fixed Issues - Inspection of "Add integration test infrastructure, refs #27" - SemanticMediaWiki/SemanticScribunto - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by mw

created 2016-12-10 05:37 UTC

SemanticScribunto.php (4 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 SMW\Scribunto\HookRegistry;

/**
 * @see https://github.com/SemanticMediaWiki/SemanticScribunto/
 *
 * @defgroup SemanticScribunto Semantic Scribunto
 */
if ( !defined( 'MEDIAWIKI' ) ) {
	die( 'This file is part of the Semantic Scribunto extension, it is not a valid entry point.' );
}

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

SemanticScribunto::load();

/**
 * @codeCoverageIgnore
 */
class SemanticScribunto {

	/**
	 * @since 1.0
	 *
	 * @note It is expected that this function is loaded before LocalSettings.php
	 * to ensure that settings and global functions are available by the time
	 * the extension is activated.
	 */
	public static function load() {

		if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
			include_once __DIR__ . '/vendor/autoload.php';
		}

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

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

	/**
	 * @since 1.0
	 */
	public static function initExtension() {

		define( 'SMW_SCRIBUNTO_VERSION', '1.0.0-alpha' );

		// Register extension info
		$GLOBALS['wgExtensionCredits']['semantic'][] = array(
			'path'           => __FILE__,
			'name'           => 'Semantic Scribunto',
			'author'         => array(
				'James Hong Kong',
				'[https://www.semantic-mediawiki.org/wiki/User:Oetterer Tobias Oetterer]',
			),
			'url'            => 'https://github.com/SemanticMediaWiki/SemanticScribunto/',
			'descriptionmsg' => 'smw-scribunto-desc',
			'version'        => SMW_SCRIBUNTO_VERSION,
			'license-name'   => 'GPL-2.0+',
		);

		// MW 1.26+
		if ( !function_exists( 'wfGlobalCacheKey' ) ) {
			function wfGlobalCacheKey( /*...*/ ) {
				$args = func_get_args();
				$key = 'global:' . implode( ':', $args );
				return strtr( $key, ' ', '_' );
			}
		}

		// Register message files
		$GLOBALS['wgMessagesDirs']['SemanticScribunto'] = __DIR__ . '/i18n';
	}

	/**
	 * @since 1.0
	 */
	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.26', 'lt' ) ) {
			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</a> is only compatible with MediaWiki 1.26 or above. You need to upgrade MediaWiki first.' );

		}

		// Using the constant as indicator to avoid class_exists
		if ( !defined( 'CONTENT_MODEL_SCRIBUNTO' ) ) {
			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</a> requires <a href="https://www.mediawiki.org/wiki/Extension:Scribunto">Scribunto</a>, please enable or install the extension first.' );

		}

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

		}
	}

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

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

		$hookRegistry = new HookRegistry();
		$hookRegistry->register();
	}

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

}


1			<?php
2
3			use SMW\Scribunto\HookRegistry;
4
5			/**
6			* @see https://github.com/SemanticMediaWiki/SemanticScribunto/
7			*
8			* @defgroup SemanticScribunto Semantic Scribunto
9			*/
10			if ( !defined( 'MEDIAWIKI' ) ) {
11			die( 'This file is part of the Semantic Scribunto extension, it is not a valid entry point.' );
12			}
13
14			if ( defined( 'SMW_SCRIBUNTO_VERSION' ) ) {
15			// Do not initialize more than once.
16			return 1;
17			}
18
19			SemanticScribunto::load();
20
21			/**
22			* @codeCoverageIgnore
23			*/
24			class SemanticScribunto {
25
26			/**
27			* @since 1.0
28			*
29			* @note It is expected that this function is loaded before LocalSettings.php
30			* to ensure that settings and global functions are available by the time
31			* the extension is activated.
32			*/
33			public static function load() {
34
35			if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
36			include_once __DIR__ . '/vendor/autoload.php';
37			}
38
39			// In case extension.json is being used, the the succeeding steps will
40			// be handled by the ExtensionRegistry
41			self::initExtension();
42
43			$GLOBALS['wgExtensionFunctions'][] = function() {
44			self::onExtensionFunction();
45			};
46			}
47
48			/**
49			* @since 1.0
50			*/
51			public static function initExtension() {
52
53			define( 'SMW_SCRIBUNTO_VERSION', '1.0.0-alpha' );
54
55			// Register extension info
56			$GLOBALS['wgExtensionCredits']['semantic'][] = array(
57			'path' => __FILE__,
58			'name' => 'Semantic Scribunto',
59			'author' => array(
60			'James Hong Kong',
61			'[https://www.semantic-mediawiki.org/wiki/User:Oetterer Tobias Oetterer]',
62			),
63			'url' => 'https://github.com/SemanticMediaWiki/SemanticScribunto/',
64			'descriptionmsg' => 'smw-scribunto-desc',
65			'version' => SMW_SCRIBUNTO_VERSION,
66			'license-name' => 'GPL-2.0+',
67			);
68
69			// MW 1.26+
70			if ( !function_exists( 'wfGlobalCacheKey' ) ) {
71			function wfGlobalCacheKey( /.../ ) {
72			$args = func_get_args();
73			$key = 'global:' . implode( ':', $args );
74			return strtr( $key, ' ', '_' );
75			}
76			}
77
78			// Register message files
79			$GLOBALS['wgMessagesDirs']['SemanticScribunto'] = __DIR__ . '/i18n';
80			}
81
82			/**
83			* @since 1.0
84			*/
85			public static function checkRequirements() {
			0 ignored issues – show Coding Style introduced 2016-11-12 06:10 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...
86
87			if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.26', 'lt' ) ) {
88			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</a> is only compatible with MediaWiki 1.26 or above. You need to upgrade MediaWiki first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-12 06:10 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...
89			}
90
91			// Using the constant as indicator to avoid class_exists
92			if ( !defined( 'CONTENT_MODEL_SCRIBUNTO' ) ) {
93			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</a> requires <a href="https://www.mediawiki.org/wiki/Extension:Scribunto">Scribunto</a>, please enable or install the extension first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-22 17:13 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...
94			}
95
96			if ( !defined( 'SMW_VERSION' ) ) {
97			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</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 2016-11-22 17:13 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...
98			}
99			}
100
101			/**
102			* @since 1.0
103			*/
104			public static function onExtensionFunction() {
105
106			// Check requirements after LocalSetting.php has been processed
107			self::checkRequirements();
108
109			$hookRegistry = new HookRegistry();
110			$hookRegistry->register();
111			}
112
113			/**
114			* @since 1.0
115			*
116			* @return string\|null
117			*/
118			public static function getVersion() {
119			return SMW_SCRIBUNTO_VERSION;
120			}
121
122			}
123

SemanticMediaWiki / SemanticScribunto

Pull Request — master (#28)

SemanticScribunto.php (4 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like