SemanticCite::load() - Code Metrics - Inspection of "Use `SMW::Config::BeforeCompletion`" - SemanticMediaWiki/SemanticCite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#39)

by mw

created 2016-12-18 13:57 UTC

SemanticCite::load() A

↳ Parent: SemanticCite

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	0

<?php


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

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

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

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() {
// 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 the succeeding steps are
		// expected to be handled by the ExtensionRegistry
		self::initExtension();

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

	/**
	 * @since 1.1
	 */
	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( 'SCI_VERSION', '1.3.0-alpha' );

		// Register the extension
		$GLOBALS['wgExtensionCredits']['semantic'][ ] = array(
			'path'           => __FILE__,
			'name'           => 'Semantic Cite',
			'author'         => array( 'James Hong Kong' ),
			'url'            => 'https://github.com/SemanticMediaWiki/SemanticCite/',
			'descriptionmsg' => 'sci-desc',
			'version'        => SCI_VERSION,
			'license-name'   => 'GPL-2.0+',
		);

		// 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'] = array(
			'styles'  => 'res/scite.styles.css',
			'localBasePath' => __DIR__ ,
			'remoteExtPath' => 'SemanticCite',
			'position' => 'top',
			'group'    => 'ext.smw',
			'targets' => array(
				'mobile',
				'desktop'
			)
		);

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

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

		self::onBeforeExtensionFunction();
	}

	/**
	 * Register hooks that require to be listed as soon as possible and preferable
	 * before the execution of onExtensionFunction
	 *
	 * @since 1.3
	 */
	public static function onBeforeExtensionFunction() {
// 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);
    }
}
		$GLOBALS['wgHooks']['SMW::Config::BeforeCompletion'][] = '\SCI\HookRegistry::onBeforeConfigCompletion';
	}

	/**
	 * @since 1.3
	 */
	public static function doCheckRequirements() {
// 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.24', 'lt' ) ) {
			die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticCite/">SemanticCite</a> is only compatible with MediaWiki 1.24 or above. You need to upgrade MediaWiki first.' );

		}

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

		}
	}

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

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

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

		$configuration = array(
			'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() {
		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 26 and the first side effect is on line 13. 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			if ( !defined( 'MEDIAWIKI' ) ) {
13			die( 'This file is part of the SemanticCite extension, it is not a valid entry point.' );
14			}
15
16			if ( defined( 'SCI_VERSION' ) ) {
17			// Do not initialize more than once.
18			return 1;
19			}
20
21			SemanticCite::load();
22
23			/**
24			* @codeCoverageIgnore
25			*/
26			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...
27
28			/**
29			* @since 1.3
30			*
31			* @note It is expected that this function is loaded before LocalSettings.php
32			* to ensure that settings and global functions are available by the time
33			* the extension is activated.
34			*/
35			public static function load() {
			0 ignored issues – show Coding Style introduced 2016-12-10 07:06 UTC by Report Bug Copy Issue Report `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...
36
37			if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
38			include_once __DIR__ . '/vendor/autoload.php';
39			}
40
41			// Load DefaultSettings
42			require_once __DIR__ . '/DefaultSettings.php';
43
44			// In case extension.json is being used, the the succeeding steps are
45			// expected to be handled by the ExtensionRegistry
46			self::initExtension();
47
48			$GLOBALS['wgExtensionFunctions'][] = function() {
49			self::onExtensionFunction();
50			};
51			}
52
53			/**
54			* @since 1.1
55			*/
56			public static function initExtension() {
			0 ignored issues – show Coding Style introduced 2016-06-22 02:10 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...
57
58			define( 'SCI_VERSION', '1.3.0-alpha' );
59
60			// Register the extension
61			$GLOBALS['wgExtensionCredits']['semantic'][ ] = array(
62			'path' => __FILE__,
63			'name' => 'Semantic Cite',
64			'author' => array( 'James Hong Kong' ),
65			'url' => 'https://github.com/SemanticMediaWiki/SemanticCite/',
66			'descriptionmsg' => 'sci-desc',
67			'version' => SCI_VERSION,
68			'license-name' => 'GPL-2.0+',
69			);
70
71			// Register message files
72			$GLOBALS['wgMessagesDirs']['SemanticCite'] = __DIR__ . '/i18n';
73			$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteMagic'] = __DIR__ . '/i18n/SemanticCite.magic.php';
74			$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteAlias'] = __DIR__ . '/i18n/SemanticCite.alias.php';
75
76			$GLOBALS['wgSpecialPages']['FindCitableMetadata'] = '\SCI\Specials\SpecialFindCitableMetadata';
77
78			// Restrict access to the meta search for registered users only
79			$GLOBALS['wgAvailableRights'][] = 'sci-metadatasearch';
80			$GLOBALS['wgGroupPermissions']['user']['sci-metadatasearch'] = true;
81
82			// Register resource files
83			$GLOBALS['wgResourceModules']['ext.scite.styles'] = array(
84			'styles' => 'res/scite.styles.css',
85			'localBasePath' => __DIR__ ,
86			'remoteExtPath' => 'SemanticCite',
87			'position' => 'top',
88			'group' => 'ext.smw',
89			'targets' => array(
90			'mobile',
91			'desktop'
92			)
93			);
94
95			$GLOBALS['wgResourceModules']['ext.scite.metadata'] = array(
96			'scripts' => array(
97			'res/scite.text.selector.js',
98			'res/scite.page.creator.js'
99			),
100			'localBasePath' => __DIR__ ,
101			'remoteExtPath' => 'SemanticCite',
102			'position' => 'top',
103			'group' => 'ext.smw',
104			'dependencies' => array(
105			'ext.scite.styles',
106			'mediawiki.api'
107			),
108			'targets' => array(
109			'mobile',
110			'desktop'
111			)
112			);
113
114			$GLOBALS['wgResourceModules']['ext.scite.tooltip'] = array(
115			'scripts' => array(
116			'res/scite.tooltip.js'
117			),
118			'localBasePath' => __DIR__ ,
119			'remoteExtPath' => 'SemanticCite',
120			'dependencies' => array(
121			'onoi.qtip',
122			'onoi.blobstore',
123			'onoi.util',
124			'ext.scite.styles',
125			'mediawiki.api.parse'
126			),
127			'messages' => array(
128			'sci-tooltip-citation-lookup-failure',
129			'sci-tooltip-citation-lookup-failure-multiple'
130			),
131			'targets' => array(
132			'mobile',
133			'desktop'
134			)
135			);
136
137			self::onBeforeExtensionFunction();
138			}
139
140			/**
141			* Register hooks that require to be listed as soon as possible and preferable
142			* before the execution of onExtensionFunction
143			*
144			* @since 1.3
145			*/
146			public static function onBeforeExtensionFunction() {
			0 ignored issues – show Coding Style introduced 2016-12-18 14:00 UTC by Report Bug Copy Issue Report `onBeforeExtensionFunction` 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...
147			$GLOBALS['wgHooks']['SMW::Config::BeforeCompletion'][] = '\SCI\HookRegistry::onBeforeConfigCompletion';
148			}
149
150			/**
151			* @since 1.3
152			*/
153			public static function doCheckRequirements() {
			0 ignored issues – show Coding Style introduced 2016-12-10 07:06 UTC by Report Bug Copy Issue Report `doCheckRequirements` 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...
154
155			if ( version_compare( $GLOBALS[ 'wgVersion' ], '1.24', 'lt' ) ) {
156			die( '<b>Error:</b> This version of <a href="https://github.com/SemanticMediaWiki/SemanticCite/">SemanticCite</a> is only compatible with MediaWiki 1.24 or above. You need to upgrade MediaWiki first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-10 07:06 UTC by Report Bug Copy Issue Report The method `doCheckRequirements()` 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...
157			}
158
159			if ( !defined( 'SMW_VERSION' ) ) {
160			die( '<b>Error:</b> <a href="https://github.com/SemanticMediaWiki/SemanticCite/">Semantic Cite</a> requires the <a href="https://github.com/SemanticMediaWiki/SemanticMediaWiki/">Semantic MediaWiki</a> extension, please enable or install the extension first.' );
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-10 07:06 UTC by Report Bug Copy Issue Report The method `doCheckRequirements()` 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...
161			}
162			}
163
164			/**
165			* @since 1.1
166			*/
167			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...
168
169			// Check requirements after LocalSetting.php has been processed
170			self::doCheckRequirements();
171
172			// Require a global because MW's Special page is missing an interface
173			// to inject dependencies
174			$GLOBALS['scigCachePrefix'] = $GLOBALS['wgCachePrefix'] === false ? wfWikiID() : $GLOBALS['wgCachePrefix'];
175
176			$configuration = array(
177			'numberOfReferenceListColumns' => $GLOBALS['scigNumberOfReferenceListColumns'],
178			'browseLinkToCitationResource' => $GLOBALS['scigBrowseLinkToCitationResource'],
179			'showTooltipForCitationReference' => $GLOBALS['scigShowTooltipForCitationReference'],
180			'tooltipRequestCacheTTL' => $GLOBALS['scigTooltipRequestCacheTTLInSeconds'],
181			'citationReferenceCaptionFormat' => $GLOBALS['scigCitationReferenceCaptionFormat'],
182			'referenceListType' => $GLOBALS['scigReferenceListType'],
183			'enabledStrictParserValidation' => $GLOBALS['scigEnabledStrictParserValidation'],
184			'cachePrefix' => $GLOBALS['scigCachePrefix'],
185			'enabledCitationTextChangeUpdateJob' => $GLOBALS['scigEnabledCitationTextChangeUpdateJob'],
186			'responsiveMonoColumnCharacterBoundLength' => $GLOBALS['scigResponsiveMonoColumnCharacterBoundLength']
187			);
188
189			$applicationFactory = ApplicationFactory::getInstance();
190
191			$hookRegistry = new HookRegistry(
192			$applicationFactory->getStore(),
193			$applicationFactory->newCacheFactory()->newMediaWikiCompositeCache( $GLOBALS['scigReferenceListCacheType'] ),
194			new Options( $configuration )
195			);
196
197			$hookRegistry->register();
198			}
199
200			/**
201			* @since 1.1
202			*
203			* @return string\|null
204			*/
205			public static function getVersion() {
206			return SCI_VERSION;
207			}
208
209			}
210

SemanticMediaWiki / SemanticCite

Pull Request — master (#39)

SemanticCite::load() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like