SemanticCite::doCheckRequirements() - Code Metrics - Inspection of "Add extension.json support (#62)" - SemanticMediaWiki/SemanticCite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1dd58a...87fd77 )

by Karsten

created 2018-10-06 20:15 UTC

SemanticCite::doCheckRequirements() A

↳ Parent: SemanticCite

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	3
nc	3
nop	0

<?php


use SCI\HookRegistry;
use SCI\Options;
use SMW\ApplicationFactory;

/**
 * @see https://github.com/SemanticMediaWiki/SemanticCite/
 *
 * @defgroup SCI Semantic Citation
 */
SemanticCite::load();

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

class YourClass { }

	/**
	 * @since 1.3
	 *
	 * @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';
		}

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

	/**
	 * @since 1.1
	 */
	public static function initExtension( $credits = array() ) {
// 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);
    }
}

		// See https://phabricator.wikimedia.org/T151136
		define( 'SCI_VERSION', isset( $credits['version'] ) ? $credits['version'] : 'UNKNOWN' );

		// Extend the upgrade key provided by SMW to ensure that an DB
		// schema is updated accordingly before using the extension
		if ( isset( $GLOBALS['smwgUpgradeKey'] ) ) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
		//	$GLOBALS['smwgUpgradeKey'] .= ':scite:2018-09';

		}

		// Register message files
		$GLOBALS['wgMessagesDirs']['SemanticCite'] = __DIR__ . '/i18n';
		$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteMagic'] = __DIR__ . '/i18n/SemanticCite.magic.php';
		$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteAlias'] = __DIR__ . '/i18n/SemanticCite.alias.php';

		$GLOBALS['wgSpecialPages']['FindCitableMetadata'] = '\SCI\Specials\SpecialFindCitableMetadata';

		// Restrict access to the meta search for registered users only
		$GLOBALS['wgAvailableRights'][] = 'sci-metadatasearch';
		$GLOBALS['wgGroupPermissions']['user']['sci-metadatasearch'] = true;

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

		$GLOBALS['wgResourceModules']['ext.scite.metadata'] = [
			'scripts' => [
				'res/scite.text.selector.js',
				'res/scite.page.creator.js'
			],
			'localBasePath' => __DIR__ ,
			'remoteExtPath' => 'SemanticCite',
			'position' => 'top',
			'group'    => 'ext.smw',
			'dependencies'  => [
				'ext.scite.styles',
				'mediawiki.api'
			],
			'targets' => [
				'mobile',
				'desktop'
			]
		];

		$GLOBALS['wgResourceModules']['ext.scite.tooltip'] = [
			'scripts' => [
				'res/scite.tooltip.js'
			],
			'localBasePath' => __DIR__ ,
			'remoteExtPath' => 'SemanticCite',
			'dependencies'  => [
				'onoi.qtip',
				'onoi.blobstore',
				'onoi.util',
				'ext.scite.styles',
				'mediawiki.api.parse'
			],
			'messages' => [
				'sci-tooltip-citation-lookup-failure',
				'sci-tooltip-citation-lookup-failure-multiple'
			],
			'targets' => [
				'mobile',
				'desktop'
			]
		];

		// Register hooks that require to be listed as soon as possible and preferable
		// before the execution of onExtensionFunction
		HookRegistry::initExtension( $GLOBALS );
	}

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

		if ( !defined( 'SMW_VERSION' ) ) {
			if ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' ) {
				die( "\nThe 'Semantic Cite' extension requires 'Semantic MediaWiki' to be installed and enabled.\n" );

			} else {
				die( '<b>Error:</b> The <a href="https://github.com/SemanticMediaWiki/SemanticCite/">Semantic Cite</a> extension requires <a href="https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki">Semantic MediaWiki</a> to be installed and enabled.<br />' );

			}
		}

		// Require a global because MW's Special page is missing an interface
		// to inject dependencies
		$GLOBALS['scigCachePrefix'] = $GLOBALS['wgCachePrefix'] === false ? wfWikiID() : $GLOBALS['wgCachePrefix'];

		$configuration = [
			'numberOfReferenceListColumns'       => $GLOBALS['scigNumberOfReferenceListColumns'],
			'browseLinkToCitationResource'       => $GLOBALS['scigBrowseLinkToCitationResource'],
			'showTooltipForCitationReference'    => $GLOBALS['scigShowTooltipForCitationReference'],
			'tooltipRequestCacheTTL'             => $GLOBALS['scigTooltipRequestCacheTTLInSeconds'],
			'citationReferenceCaptionFormat'     => $GLOBALS['scigCitationReferenceCaptionFormat'],
			'referenceListType'                  => $GLOBALS['scigReferenceListType'],
			'enabledStrictParserValidation'      => $GLOBALS['scigEnabledStrictParserValidation'],
			'cachePrefix'                        => $GLOBALS['scigCachePrefix'],
			'enabledCitationTextChangeUpdateJob' => $GLOBALS['scigEnabledCitationTextChangeUpdateJob'],
			'responsiveMonoColumnCharacterBoundLength' => $GLOBALS['scigResponsiveMonoColumnCharacterBoundLength']
		];

		$applicationFactory = ApplicationFactory::getInstance();

		$hookRegistry = new HookRegistry(
			$applicationFactory->getStore(),
			$applicationFactory->newCacheFactory()->newMediaWikiCompositeCache( $GLOBALS['scigReferenceListCacheType'] ),
			new Options( $configuration )
		);

		$hookRegistry->register();
	}

	/**
	 * @since 1.1
	 *
	 * @return string|null
	 */
	public static function getVersion() {

		if ( !defined( 'SCI_VERSION' ) ) {
			return null;
		}

		return SCI_VERSION;
	}

}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-13 01:28 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 17 and the first side effect is on line 12. 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 SCI\HookRegistry;
4			use SCI\Options;
5			use SMW\ApplicationFactory;
6
7			/**
8			* @see https://github.com/SemanticMediaWiki/SemanticCite/
9			*
10			* @defgroup SCI Semantic Citation
11			*/
12			SemanticCite::load();
13
14			/**
15			* @codeCoverageIgnore
16			*/
17			class SemanticCite {
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-22 02:10 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...
18
19			/**
20			* @since 1.3
21			*
22			* @note It is expected that this function is loaded before LocalSettings.php
23			* to ensure that settings and global functions are available by the time
24			* the extension is activated.
25			*/
26			public static function load() {
27
28			if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
29			include_once __DIR__ . '/vendor/autoload.php';
30			}
31
32			// Load DefaultSettings
33			require_once __DIR__ . '/DefaultSettings.php';
34			}
35
36			/**
37			* @since 1.1
38			*/
39			public static function initExtension( $credits = array() ) {
			0 ignored issues – show Coding Style introduced 2018-09-30 12:55 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...
40
41			// See https://phabricator.wikimedia.org/T151136
42			define( 'SCI_VERSION', isset( $credits['version'] ) ? $credits['version'] : 'UNKNOWN' );
43
44			// Extend the upgrade key provided by SMW to ensure that an DB
45			// schema is updated accordingly before using the extension
46			if ( isset( $GLOBALS['smwgUpgradeKey'] ) ) {
			0 ignored issues – show Unused Code introduced 2018-09-30 12:55 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
47			// $GLOBALS['smwgUpgradeKey'] .= ':scite:2018-09';
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-09-30 12:55 UTC by Report Bug Copy Issue Report `55%` 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...
48			}
49
50			// Register message files
51			$GLOBALS['wgMessagesDirs']['SemanticCite'] = __DIR__ . '/i18n';
52			$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteMagic'] = __DIR__ . '/i18n/SemanticCite.magic.php';
53			$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteAlias'] = __DIR__ . '/i18n/SemanticCite.alias.php';
54
55			$GLOBALS['wgSpecialPages']['FindCitableMetadata'] = '\SCI\Specials\SpecialFindCitableMetadata';
56
57			// Restrict access to the meta search for registered users only
58			$GLOBALS['wgAvailableRights'][] = 'sci-metadatasearch';
59			$GLOBALS['wgGroupPermissions']['user']['sci-metadatasearch'] = true;
60
61			// Register resource files
62			$GLOBALS['wgResourceModules']['ext.scite.styles'] = [
63			'styles' => 'res/scite.styles.css',
64			'localBasePath' => __DIR__ ,
65			'remoteExtPath' => 'SemanticCite',
66			'position' => 'top',
67			'group' => 'ext.smw',
68			'targets' => [
69			'mobile',
70			'desktop'
71			]
72			];
73
74			$GLOBALS['wgResourceModules']['ext.scite.metadata'] = [
75			'scripts' => [
76			'res/scite.text.selector.js',
77			'res/scite.page.creator.js'
78			],
79			'localBasePath' => __DIR__ ,
80			'remoteExtPath' => 'SemanticCite',
81			'position' => 'top',
82			'group' => 'ext.smw',
83			'dependencies' => [
84			'ext.scite.styles',
85			'mediawiki.api'
86			],
87			'targets' => [
88			'mobile',
89			'desktop'
90			]
91			];
92
93			$GLOBALS['wgResourceModules']['ext.scite.tooltip'] = [
94			'scripts' => [
95			'res/scite.tooltip.js'
96			],
97			'localBasePath' => __DIR__ ,
98			'remoteExtPath' => 'SemanticCite',
99			'dependencies' => [
100			'onoi.qtip',
101			'onoi.blobstore',
102			'onoi.util',
103			'ext.scite.styles',
104			'mediawiki.api.parse'
105			],
106			'messages' => [
107			'sci-tooltip-citation-lookup-failure',
108			'sci-tooltip-citation-lookup-failure-multiple'
109			],
110			'targets' => [
111			'mobile',
112			'desktop'
113			]
114			];
115
116			// Register hooks that require to be listed as soon as possible and preferable
117			// before the execution of onExtensionFunction
118			HookRegistry::initExtension( $GLOBALS );
119			}
120
121			/**
122			* @since 1.1
123			*/
124			public static function onExtensionFunction() {
			0 ignored issues – show Coding Style introduced 2016-06-22 02:10 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...
125
126			if ( !defined( 'SMW_VERSION' ) ) {
127			if ( PHP_SAPI === 'cli' \|\| PHP_SAPI === 'phpdbg' ) {
128			die( "\nThe 'Semantic Cite' extension requires 'Semantic MediaWiki' to be installed and enabled.\n" );
			0 ignored issues – show Coding Style Compatibility introduced 2018-09-30 12:55 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...
129			} else {
130			die( '<b>Error:</b> The <a href="https://github.com/SemanticMediaWiki/SemanticCite/">Semantic Cite</a> extension requires <a href="https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki">Semantic MediaWiki</a> to be installed and enabled.<br />' );
			0 ignored issues – show Coding Style Compatibility introduced 2018-09-30 12:55 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...
131			}
132			}
133
134			// Require a global because MW's Special page is missing an interface
135			// to inject dependencies
136			$GLOBALS['scigCachePrefix'] = $GLOBALS['wgCachePrefix'] === false ? wfWikiID() : $GLOBALS['wgCachePrefix'];
137
138			$configuration = [
139			'numberOfReferenceListColumns' => $GLOBALS['scigNumberOfReferenceListColumns'],
140			'browseLinkToCitationResource' => $GLOBALS['scigBrowseLinkToCitationResource'],
141			'showTooltipForCitationReference' => $GLOBALS['scigShowTooltipForCitationReference'],
142			'tooltipRequestCacheTTL' => $GLOBALS['scigTooltipRequestCacheTTLInSeconds'],
143			'citationReferenceCaptionFormat' => $GLOBALS['scigCitationReferenceCaptionFormat'],
144			'referenceListType' => $GLOBALS['scigReferenceListType'],
145			'enabledStrictParserValidation' => $GLOBALS['scigEnabledStrictParserValidation'],
146			'cachePrefix' => $GLOBALS['scigCachePrefix'],
147			'enabledCitationTextChangeUpdateJob' => $GLOBALS['scigEnabledCitationTextChangeUpdateJob'],
148			'responsiveMonoColumnCharacterBoundLength' => $GLOBALS['scigResponsiveMonoColumnCharacterBoundLength']
149			];
150
151			$applicationFactory = ApplicationFactory::getInstance();
152
153			$hookRegistry = new HookRegistry(
154			$applicationFactory->getStore(),
155			$applicationFactory->newCacheFactory()->newMediaWikiCompositeCache( $GLOBALS['scigReferenceListCacheType'] ),
156			new Options( $configuration )
157			);
158
159			$hookRegistry->register();
160			}
161
162			/**
163			* @since 1.1
164			*
165			* @return string\|null
166			*/
167			public static function getVersion() {
168
169			if ( !defined( 'SCI_VERSION' ) ) {
170			return null;
171			}
172
173			return SCI_VERSION;
174			}
175
176			}
177

SemanticMediaWiki / SemanticCite

Push — master ( 1dd58a...87fd77 )

SemanticCite::doCheckRequirements() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like