SemanticScribunto::checkRequirements() - Code Metrics - Inspection of "Check for minimum dependency using CONTENT_MODEL_S..." - SemanticMediaWiki/SemanticScribunto - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bdd9af...f60d39 )

by mw

created 2016-11-12 05:33 UTC

SemanticScribunto::checkRequirements() A

↳ Parent: SemanticScribunto

Complexity

Conditions	4
Paths	4

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	4
nop	0
dl	0
loc	15
rs	9.2
c	0
b	0
f	0

<?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::initExtension();

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

/**
 * @codeCoverageIgnore
 */
class SemanticScribunto {
namespace YourVendor;

class YourClass { }

	/**
	 * @since 1.0
	 */
	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);
    }
}

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

		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' ),
			'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 the Scribunto extension, please enable or install <a href="https://www.mediawiki.org/wiki/Extension:Scribunto">Scribunto</a> first.' );

		}

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

		}
	}

	/**
	 * @since 1.0
	 */
	public static function onExtensionFunction() {
		self::checkRequirements();

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

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

}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-07 13:25 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 28 and the first side effect is on line 11. 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			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::initExtension();
20
21			$GLOBALS['wgExtensionFunctions'][] = function() {
22			SemanticScribunto::onExtensionFunction();
23			};
24
25			/**
26			* @codeCoverageIgnore
27			*/
28			class SemanticScribunto {
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-12 04:35 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
29
30			/**
31			* @since 1.0
32			*/
33			public static function initExtension() {
			0 ignored issues – show Coding Style introduced 2016-11-12 04:35 UTC by Report Bug Copy Issue Report `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...
34
35			if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
36			include_once __DIR__ . '/vendor/autoload.php';
37			}
38
39			define( 'SMW_SCRIBUNTO_VERSION', '1.0.0-alpha' );
40
41			// Register extension info
42			$GLOBALS['wgExtensionCredits']['semantic'][] = array(
43			'path' => __FILE__,
44			'name' => 'Semantic Scribunto',
45			'author' => array( 'James Hong Kong' ),
46			'url' => 'https://github.com/SemanticMediaWiki/SemanticScribunto/',
47			'descriptionmsg' => 'smw-scribunto-desc',
48			'version' => SMW_SCRIBUNTO_VERSION,
49			'license-name' => 'GPL-2.0+',
50			);
51
52			// MW 1.26+
53			if ( !function_exists( 'wfGlobalCacheKey' ) ) {
54			function wfGlobalCacheKey( /.../ ) {
			0 ignored issues – show Best Practice introduced 2016-11-12 04:35 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
55			$args = func_get_args();
56			$key = 'global:' . implode( ':', $args );
57			return strtr( $key, ' ', '_' );
58			}
59			}
60
61			// Register message files
62			$GLOBALS['wgMessagesDirs']['SemanticScribunto'] = __DIR__ . '/i18n';
63			}
64
65			/**
66			* @since 1.0
67			*/
68			public static function checkRequirements() {
			0 ignored issues – show Coding Style introduced 2016-11-12 06:10 UTC by Report Bug Copy Issue Report `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...
69
70			if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.26', 'lt' ) ) {
71			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 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...
72			}
73
74			// Using the constant as indicator to avoid class_exists
75			if ( !defined( 'CONTENT_MODEL_SCRIBUNTO' ) ) {
76			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</a> requires the Scribunto extension, please enable or install <a href="https://www.mediawiki.org/wiki/Extension:Scribunto">Scribunto</a> first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-12 06:10 UTC by Report Bug Copy Issue Report 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...
77			}
78
79			if ( !defined( 'SMW_VERSION' ) ) {
80			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticScribunto/">Semantic Scribunto</a> requires the Semantic MediaWiki extension, please enable or install <a href="https://github.com/SemanticMediaWiki/SemanticMediaWiki/">Semantic MediaWiki</a> first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-12 06:10 UTC by Report Bug Copy Issue Report 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...
81			}
82			}
83
84			/**
85			* @since 1.0
86			*/
87			public static function onExtensionFunction() {
88			self::checkRequirements();
89
90			$hookRegistry = new HookRegistry();
91			$hookRegistry->register();
92			}
93
94			/**
95			* @since 1.0
96			*
97			* @return string\|null
98			*/
99			public static function getVersion() {
100			return SMW_SCRIBUNTO_VERSION;
101			}
102
103			}
104

SemanticMediaWiki / SemanticScribunto

Push — master ( bdd9af...f60d39 )

SemanticScribunto::checkRequirements() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like