Issues in SemanticCite.php - New Issues - Inspection of "1.1.0 release preparations" - SemanticMediaWiki/SemanticCite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by mw

created 2016-06-22 02:04 UTC

SemanticCite.php (3 issues)

Labels

Severity

Minor 3

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 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 ( 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( 'SCI_VERSION' ) ) {
	// Do not initialize more than once.
	return 1;
}

SemanticCite::initExtension();

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

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

class YourClass { }

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

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

		define( 'SCI_VERSION', '1.1.0-alpha' );

		// Register the extension
		$GLOBALS['wgExtensionCredits']['semantic'][ ] = array(
			'path'           => __DIR__,
			'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'
			)
		);
	}

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

		// 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'],
			'strictParserValidationEnabled'      => $GLOBALS['scigStrictParserValidationEnabled'],
			'cachePrefix'                        => $GLOBALS['scigCachePrefix'],
			'enabledCitationTextChangeUpdateJob' => $GLOBALS['scigEnabledCitationTextChangeUpdateJob']
		);

		$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
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 ( version_compare( $GLOBALS[ 'wgVersion' ], '1.24', 'lt' ) ) {
17			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.' );
18			}
19
20			if ( defined( 'SCI_VERSION' ) ) {
21			// Do not initialize more than once.
22			return 1;
23			}
24
25			SemanticCite::initExtension();
26
27			$GLOBALS['wgExtensionFunctions'][] = function() {
28			SemanticCite::onExtensionFunction();
29			};
30
31			/**
32			* @codeCoverageIgnore
33			*/
34			class SemanticCite {
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-22 02:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
35
36			/**
37			* @since 1.1
38			*/
39			public static function initExtension() {
			0 ignored issues – show Coding Style introduced 2016-06-22 02:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this `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			// Load DefaultSettings
42			require_once __DIR__ . '/DefaultSettings.php';
43
44			define( 'SCI_VERSION', '1.1.0-alpha' );
45
46			// Register the extension
47			$GLOBALS['wgExtensionCredits']['semantic'][ ] = array(
48			'path' => __DIR__,
49			'name' => 'Semantic Cite',
50			'author' => array( 'James Hong Kong' ),
51			'url' => 'https://github.com/SemanticMediaWiki/SemanticCite/',
52			'descriptionmsg' => 'sci-desc',
53			'version' => SCI_VERSION,
54			'license-name' => 'GPL-2.0+',
55			);
56
57			// Register message files
58			$GLOBALS['wgMessagesDirs']['SemanticCite'] = __DIR__ . '/i18n';
59			$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteMagic'] = __DIR__ . '/i18n/SemanticCite.magic.php';
60			$GLOBALS['wgExtensionMessagesFiles']['SemanticCiteAlias'] = __DIR__ . '/i18n/SemanticCite.alias.php';
61
62			$GLOBALS['wgSpecialPages']['FindCitableMetadata'] = '\SCI\Specials\SpecialFindCitableMetadata';
63
64			// Restrict access to the meta search for registered users only
65			$GLOBALS['wgAvailableRights'][] = 'sci-metadatasearch';
66			$GLOBALS['wgGroupPermissions']['user']['sci-metadatasearch'] = true;
67
68			// Register resource files
69			$GLOBALS['wgResourceModules']['ext.scite.styles'] = array(
70			'styles' => 'res/scite.styles.css',
71			'localBasePath' => __DIR__ ,
72			'remoteExtPath' => 'SemanticCite',
73			'position' => 'top',
74			'group' => 'ext.smw',
75			'targets' => array(
76			'mobile',
77			'desktop'
78			)
79			);
80
81			$GLOBALS['wgResourceModules']['ext.scite.metadata'] = array(
82			'scripts' => array(
83			'res/scite.text.selector.js',
84			'res/scite.page.creator.js'
85			),
86			'localBasePath' => __DIR__ ,
87			'remoteExtPath' => 'SemanticCite',
88			'position' => 'top',
89			'group' => 'ext.smw',
90			'dependencies' => array(
91			'ext.scite.styles',
92			'mediawiki.api'
93			),
94			'targets' => array(
95			'mobile',
96			'desktop'
97			)
98			);
99
100			$GLOBALS['wgResourceModules']['ext.scite.tooltip'] = array(
101			'scripts' => array(
102			'res/scite.tooltip.js'
103			),
104			'localBasePath' => __DIR__ ,
105			'remoteExtPath' => 'SemanticCite',
106			'dependencies' => array(
107			'onoi.qtip',
108			'onoi.blobstore',
109			'onoi.util',
110			'ext.scite.styles',
111			'mediawiki.api.parse'
112			),
113			'messages' => array(
114			'sci-tooltip-citation-lookup-failure',
115			'sci-tooltip-citation-lookup-failure-multiple'
116			),
117			'targets' => array(
118			'mobile',
119			'desktop'
120			)
121			);
122			}
123
124			/**
125			* @since 1.1
126			*/
127			public static function onExtensionFunction() {
			0 ignored issues – show Coding Style introduced 2016-06-22 02:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this `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...
128
129			// Require a global because MW's Special page is missing an interface
130			// to inject dependencies
131			$GLOBALS['scigCachePrefix'] = $GLOBALS['wgCachePrefix'] === false ? wfWikiID() : $GLOBALS['wgCachePrefix'];
132
133			$configuration = array(
134			'numberOfReferenceListColumns' => $GLOBALS['scigNumberOfReferenceListColumns'],
135			'browseLinkToCitationResource' => $GLOBALS['scigBrowseLinkToCitationResource'],
136			'showTooltipForCitationReference' => $GLOBALS['scigShowTooltipForCitationReference'],
137			'tooltipRequestCacheTTL' => $GLOBALS['scigTooltipRequestCacheTTLInSeconds'],
138			'citationReferenceCaptionFormat' => $GLOBALS['scigCitationReferenceCaptionFormat'],
139			'referenceListType' => $GLOBALS['scigReferenceListType'],
140			'strictParserValidationEnabled' => $GLOBALS['scigStrictParserValidationEnabled'],
141			'cachePrefix' => $GLOBALS['scigCachePrefix'],
142			'enabledCitationTextChangeUpdateJob' => $GLOBALS['scigEnabledCitationTextChangeUpdateJob']
143			);
144
145			$applicationFactory = ApplicationFactory::getInstance();
146
147			$hookRegistry = new HookRegistry(
148			$applicationFactory->getStore(),
149			$applicationFactory->newCacheFactory()->newMediaWikiCompositeCache( $GLOBALS['scigReferenceListCacheType'] ),
150			new Options( $configuration )
151			);
152
153			$hookRegistry->register();
154			}
155
156			/**
157			* @since 1.1
158			*
159			* @return string\|null
160			*/
161			public static function getVersion() {
162			return SCI_VERSION;
163			}
164
165			}
166

SemanticMediaWiki / SemanticCite

Pull Request — master (#28)

SemanticCite.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like