SemanticNotifications::onExtensionFunction() - Code Metrics - Inspection of "SMW 2.4 SMWSql3SmwIds::getDataItemForId, refs 18 (..." - SemanticMediaWiki/SemanticNotifications - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1e5fc8...4f25e0 )

by mw

created 2016-11-05 23:52 UTC

SemanticNotifications::onExtensionFunction() A

↳ Parent: SemanticNotifications

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0

<?php


use SMW\Notifications\HookRegistry;

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

if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.26', 'lt' ) ) {
	die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticNotifications/">Semantic Notifications</a> is only compatible with MediaWiki 1.26 or above. You need to upgrade MediaWiki first.' );
}

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

SemanticNotifications::initExtension();

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

/**
 * @codeCoverageIgnore
 */
class SemanticNotifications {
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);
    }
}

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

		// Register extension info
		$GLOBALS['wgExtensionCredits']['semantic'][] = array(
			'path'           => __FILE__,
			'name'           => 'Semantic Notifications',
			'author'         => array( 'James Hong Kong' ),
			'url'            => 'https://github.com/SemanticMediaWiki/SemanticNotifications/',
			'descriptionmsg' => 'smw-notifications-desc',
			'version'        => SMW_NOTIFICATIONS_VERSION,
			'license-name'   => 'GPL-2.0+',
		);

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

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

		// There is no good way to detect whether Echo is available or not without
		// making a class_exists, what should I say ...
		if ( !isset( $GLOBALS['wgMessagesDirs']['Echo'] ) ) {
			die( '<b>Error:</b><a href="https://github.com/SemanticMediaWiki/SemanticNotifications/">Semantic Notifications</a> requires the <a href="https://www.mediawiki.org/wiki/Extension:Echo">Echo(Notifications)</a> extension. Please install and activate this extension first.' );

		}

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

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

}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-19 04:35 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 32 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\Notifications\HookRegistry;
4
5			/**
6			* @see https://github.com/SemanticMediaWiki/SemanticNotifications/
7			*
8			* @defgroup SemanticNotifications Semantic Notifications
9			*/
10			if ( !defined( 'MEDIAWIKI' ) ) {
11			die( 'This file is part of the Semantic Notifications extension, it is not a valid entry point.' );
12			}
13
14			if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.26', 'lt' ) ) {
15			die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticNotifications/">Semantic Notifications</a> is only compatible with MediaWiki 1.26 or above. You need to upgrade MediaWiki first.' );
16			}
17
18			if ( defined( 'SMW_NOTIFICATIONS_VERSION' ) ) {
19			// Do not initialize more than once.
20			return 1;
21			}
22
23			SemanticNotifications::initExtension();
24
25			$GLOBALS['wgExtensionFunctions'][] = function() {
26			SemanticNotifications::onExtensionFunction();
27			};
28
29			/**
30			* @codeCoverageIgnore
31			*/
32			class SemanticNotifications {
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-19 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...
33
34			/**
35			* @since 1.0
36			*/
37			public static function initExtension() {
			0 ignored issues – show Coding Style introduced 2016-06-19 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...
38
39			define( 'SMW_NOTIFICATIONS_VERSION', '1.0.0-alpha' );
40
41			// Register extension info
42			$GLOBALS['wgExtensionCredits']['semantic'][] = array(
43			'path' => __FILE__,
44			'name' => 'Semantic Notifications',
45			'author' => array( 'James Hong Kong' ),
46			'url' => 'https://github.com/SemanticMediaWiki/SemanticNotifications/',
47			'descriptionmsg' => 'smw-notifications-desc',
48			'version' => SMW_NOTIFICATIONS_VERSION,
49			'license-name' => 'GPL-2.0+',
50			);
51
52			// Register message files
53			$GLOBALS['wgMessagesDirs']['SemanticNotifications'] = __DIR__ . '/i18n';
54			}
55
56			/**
57			* @since 1.0
58			*/
59			public static function onExtensionFunction() {
			0 ignored issues – show Coding Style introduced 2016-06-19 04:35 UTC by Report Bug Copy Issue Report `onExtensionFunction` 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...
60
61			// There is no good way to detect whether Echo is available or not without
62			// making a class_exists, what should I say ...
63			if ( !isset( $GLOBALS['wgMessagesDirs']['Echo'] ) ) {
64			die( '<b>Error:</b><a href="https://github.com/SemanticMediaWiki/SemanticNotifications/">Semantic Notifications</a> requires the <a href="https://www.mediawiki.org/wiki/Extension:Echo">Echo(Notifications)</a> extension. Please install and activate this extension first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-19 04:35 UTC by Report Bug Copy Issue Report The method `onExtensionFunction()` 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...
65			}
66
67			$hookRegistry = new HookRegistry();
68			$hookRegistry->register();
69			}
70
71			/**
72			* @since 1.0
73			*
74			* @return string\|null
75			*/
76			public static function getVersion() {
77			return SMW_NOTIFICATIONS_VERSION;
78			}
79
80			}
81

SemanticMediaWiki / SemanticNotifications

Push — master ( 1e5fc8...4f25e0 )

SemanticNotifications::onExtensionFunction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like