Hooks::onChangeFile() - Code Metrics - Inspection of "Use `RevisionGuard` hooks" - SemanticMediaWiki/SemanticApprovedRevs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

by mw

created 2019-04-06 18:36 UTC

Hooks::onChangeFile() A

↳ Parent: Hooks

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
ccs	5
cts	5
cp	1
cc	1
nc	1
nop	2
crap	1

<?php

namespace SMW\ApprovedRevs;

use SMW\ApplicationFactory;
use Onoi\Cache\Cache;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class Hooks {

	/**
	 * @var array
	 */
	private $handlers = [];

	/**
	 * @var Cache
	 */
	private $cache;

	/**
	 * @since 1.0
	 *
	 * @param array $config
	 */
	public function __construct( $config = [] ) {
		$this->registerHandlers( $config );
	}

	/**
	 * @since 1.0
	 *
	 * @param Cache $cache
	 */
	public function setCache( Cache $cache ) {
		$this->cache = $cache;
	}

	/**
	 * @since  1.0
	 */
	public static function hasPropertyCollisions( $var ) {

		if ( !isset( $var['sespgEnabledPropertyList'] ) ) {
			return false;
		}

		// SESP properties!
		$list = [
			'_APPROVED' => true,
			'_APPROVEDBY' => true,
			'_APPROVEDDATE' => true,
			'_APPROVEDSTATUS' => true
		];

		foreach ( $var['sespgEnabledPropertyList'] as $key ) {
			if ( isset( $list[$key] ) ) {
				return $key;
			}
		}

		return false;
	}

	/**
	 * @since 1.0
	 *
	 * @param array &$vars
	 */
	public static function initExtension( &$vars ) {

		/**
		 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Config::BeforeCompletion
		 *
		 * @since 1.0
		 *
		 * @param array &$config
		 */
		$vars['wgHooks']['SMW::Config::BeforeCompletion'][] = function( &$config ) {

			if ( isset( $config['smwgImportFileDirs'] ) ) {
				$config['smwgImportFileDirs'] += [ 'sar' => __DIR__ . '/../data/import' ];
			}

			return true;
		};
	}

	/**
	 * @since  1.0
	 */
	public function register() {
		foreach ( $this->handlers as $name => $callback ) {
			\Hooks::register( $name, $callback );
		}
	}

	/**
	 * @since  1.0
	 */
	public function deregister() {
		foreach ( array_keys( $this->handlers ) as $name ) {

			\Hooks::clear( $name );

			// Remove registered `wgHooks` hooks that are not cleared by the
			// previous call
			if ( isset( $GLOBALS['wgHooks'][$name] ) ) {
				unset( $GLOBALS['wgHooks'][$name] );
			}
		}
	}

	/**
	 * @since  1.0
	 *
	 * @param string $name
	 *
	 * @return boolean
	 */
	public function isRegistered( $name ) {
		return \Hooks::isRegistered( $name );
	}

	/**
	 * @since  1.0
	 *
	 * @param string $name
	 *
	 * @return array
	 */
	public function getHandlers( $name ) {
		return \Hooks::getHandlers( $name );
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param integer $latestRevID
	 */
	public function onIsApprovedRevision( $title, $latestRevID ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		return $approvedRevsHandler->isApprovedUpdate( $title, $latestRevID );
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param Revision|null &$revision
	 */
	public function onChangeRevision( $title, &$revision ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeRevision( $title, $revision );

		return true;
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param integer &$latestRevID
	 */
	public function onOverrideRevisionID( $title, &$latestRevID ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeRevisionID( $title, $latestRevID );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Property::initProperties
	 *
	 * @since 1.0
	 *
	 * @param ProertyRegistry $$registry
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param integer &$latestRevID
	 */
	public function onInitProperties( $registry ) {

		$propertyRegistry = new PropertyRegistry();
		$propertyRegistry->register( $registry );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMWStore::updateDataBefore
	 *
	 * @since 1.0
	 *
	 * @param ProertyRegistry $$registry
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param integer &$latestRevID
	 */
	public function onUpdateDataBefore( $store, $semanticData ) {

		$propertyAnnotator = new PropertyAnnotator(
			new ServicesFactory()
		);

		$propertyAnnotator->setLogger(
			ApplicationFactory::getInstance()->getMediaWikiLogger( 'smw-approved-revs' )
		);

		$propertyAnnotator->addAnnotation( $semanticData );

		return true;
	}

	/**
	 * @see ??
	 *
	 * @since 1.0
	 *
	 * @param ParserOutput $output
	 * @param Title $title
	 * @param integer $rev_id
	 * @param string $content
	 */
	public function onApprovedRevsRevisionApproved( $output, $title, $rev_id, $content  ) {


		$ttl = 60 * 60; // 1hr

		if ( $this->cache === null ) {
			$this->cache = ApplicationFactory::getInstance()->getCache();

		}

		// Send an event to ParserAfterTidy and allow it to pass the preliminary
		// test even in cases where the content doesn't contain any SMW related
		// annotations. It is to ensure that when an agent switches to a blank
		// version (no SMW related annotations or categories) the update is carried
		// out and the store is able to remove any remaining annotations.
		$key = smwfCacheKey( 'smw:parseraftertidy', $title->getPrefixedDBKey() );
		$this->cache->save( $key, $rev_id, $ttl );

		return true;
	}

	/**
	 * @see ??
	 *
	 * @since 1.0
	 *
	 * @param Parser $parser
	 * @param Title $title
	 * @param integer $timestamp
	 * @param string $sha1
	 */
	public function onApprovedRevsFileRevisionApproved( $parser, $title, $timestamp, $sha1  ) {

		$ttl = 60 * 60; // 1hr

		if ( $this->cache === null ) {
			$this->cache = ApplicationFactory::getInstance()->getCache();

		}

		// @see onApprovedRevsRevisionApproved for the same reason
		$key = smwfCacheKey( 'smw:parseraftertidy', $title->getPrefixedDBKey() );
		$this->cache->save( $key, $sha1, $ttl );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#...
	 *
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param File &$file
	 */
	public function onChangeFile( $title, &$file ) {

		$approvedRevsHandler = new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeFile( $title, $file );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#...
	 *
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param File &$file
	 */
	public function onChangeFileBeforeIngestProcessComplete( $title, &$file ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeFile( $title, $file );

		return true;
	}

	private function registerHandlers( $config ) {

		$this->handlers = [
			'ApprovedRevsRevisionApproved' => [ $this, 'onApprovedRevsRevisionApproved' ],
			'ApprovedRevsFileRevisionApproved' => [ $this, 'onApprovedRevsFileRevisionApproved' ],
			'SMW::RevisionGuard::IsApprovedRevision' => [ $this, 'onIsApprovedRevision' ],
			'SMW::RevisionGuard::ChangeRevision' => [ $this, 'onChangeRevision' ],
			'SMW::RevisionGuard::ChangeRevisionID' => [ $this, 'onOverrideRevisionID' ],
			'SMW::RevisionGuard::ChangeFile' => [ $this, 'onChangeFile' ],
			'SMW::Property::initProperties' => [ $this, 'onInitProperties' ],
			'SMWStore::updateDataBefore' => [ $this, 'onUpdateDataBefore' ],
		];
	}

}


1		<?php
2
3		namespace SMW\ApprovedRevs;
4
5		use SMW\ApplicationFactory;
6		use Onoi\Cache\Cache;
7
8		/**
9		* @license GNU GPL v2+
10		* @since 1.0
11		*
12		* @author mwjames
13		*/
14		class Hooks {
15
16		/**
17		* @var array
18		*/
19		private $handlers = [];
20
21		/**
22		* @var Cache
23		*/
24		private $cache;
25
26		/**
27		* @since 1.0
28		*
29		* @param array $config
30		*/
31	2	public function __construct( $config = [] ) {
32	2	$this->registerHandlers( $config );
33	2	}
34
35		/**
36		* @since 1.0
37		*
38		* @param Cache $cache
39		*/
40	1	public function setCache( Cache $cache ) {
41	1	$this->cache = $cache;
42	1	}
43
44		/**
45		* @since 1.0
46		*/
47		public static function hasPropertyCollisions( $var ) {
48
49		if ( !isset( $var['sespgEnabledPropertyList'] ) ) {
50		return false;
51		}
52
53		// SESP properties!
54		$list = [
55		'_APPROVED' => true,
56		'_APPROVEDBY' => true,
57		'_APPROVEDDATE' => true,
58		'_APPROVEDSTATUS' => true
59		];
60
61		foreach ( $var['sespgEnabledPropertyList'] as $key ) {
62		if ( isset( $list[$key] ) ) {
63		return $key;
64		}
65		}
66
67		return false;
68		}
69
70		/**
71		* @since 1.0
72		*
73		* @param array &$vars
74		*/
75		public static function initExtension( &$vars ) {
76
77		/**
78		* @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Config::BeforeCompletion
79		*
80		* @since 1.0
81		*
82		* @param array &$config
83		*/
84	1	$vars['wgHooks']['SMW::Config::BeforeCompletion'][] = function( &$config ) {
85
86	1	if ( isset( $config['smwgImportFileDirs'] ) ) {
87	1	$config['smwgImportFileDirs'] += [ 'sar' => __DIR__ . '/../data/import' ];
88		}
89
90	1	return true;
91		};
92		}
93
94		/**
95		* @since 1.0
96		*/
97	1	public function register() {
98	1	foreach ( $this->handlers as $name => $callback ) {
99	1	\Hooks::register( $name, $callback );
100		}
101	1	}
102
103		/**
104		* @since 1.0
105		*/
106	1	public function deregister() {
107	1	foreach ( array_keys( $this->handlers ) as $name ) {
108
109	1	\Hooks::clear( $name );
110
111		// Remove registered `wgHooks` hooks that are not cleared by the
112		// previous call
113	1	if ( isset( $GLOBALS['wgHooks'][$name] ) ) {
114	1	unset( $GLOBALS['wgHooks'][$name] );
115		}
116		}
117	1	}
118
119		/**
120		* @since 1.0
121		*
122		* @param string $name
123		*
124		* @return boolean
125		*/
126	1	public function isRegistered( $name ) {
127	1	return \Hooks::isRegistered( $name );
128		}
129
130		/**
131		* @since 1.0
132		*
133		* @param string $name
134		*
135		* @return array
136		*/
137	1	public function getHandlers( $name ) {
138	1	return \Hooks::getHandlers( $name );
139		}
140
141		/**
142		* @since 1.0
143		*
144		* @param Title $title
145		* @param integer $latestRevID
146		*/
147	1	public function onIsApprovedRevision( $title, $latestRevID ) {
148
149	1	$approvedRevsHandler = new ApprovedRevsHandler(
150	1	new ApprovedRevsFacade()
151		);
152
153	1	return $approvedRevsHandler->isApprovedUpdate( $title, $latestRevID );
154		}
155
156		/**
157		* @since 1.0
158		*
159		* @param Title $title
160		* @param Revision\|null &$revision
161		*/
162	1	public function onChangeRevision( $title, &$revision ) {
163
164	1	$approvedRevsHandler = new ApprovedRevsHandler(
165	1	new ApprovedRevsFacade()
166		);
167
168	1	$approvedRevsHandler->doChangeRevision( $title, $revision );
169
170	1	return true;
171		}
172
173		/**
174		* @since 1.0
175		*
176		* @param Title $title
177		* @param integer &$latestRevID
178		*/
179	1	public function onOverrideRevisionID( $title, &$latestRevID ) {
180
181	1	$approvedRevsHandler = new ApprovedRevsHandler(
182	1	new ApprovedRevsFacade()
183		);
184
185	1	$approvedRevsHandler->doChangeRevisionID( $title, $latestRevID );
186
187	1	return true;
188		}
189
190		/**
191		* @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Property::initProperties
192		*
193		* @since 1.0
194		*
195		* @param ProertyRegistry $$registry
		0 ignored issues – show Documentation introduced 2019-03-02 17:21 UTC by Report Bug Copy Issue Report There is no parameter named `$$registry`. Did you maybe mean `$registry`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
196		* @param integer &$latestRevID
197		*/
198	1	public function onInitProperties( $registry ) {
199
200	1	$propertyRegistry = new PropertyRegistry();
201	1	$propertyRegistry->register( $registry );
202
203	1	return true;
204		}
205
206		/**
207		* @see https://www.semantic-mediawiki.org/wiki/Hooks#SMWStore::updateDataBefore
208		*
209		* @since 1.0
210		*
211		* @param ProertyRegistry $$registry
		0 ignored issues – show Bug introduced 2019-03-02 17:21 UTC by Report Bug Copy Issue Report There is no parameter named `$$registry`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
212		* @param integer &$latestRevID
213		*/
214	1	public function onUpdateDataBefore( $store, $semanticData ) {
215
216	1	$propertyAnnotator = new PropertyAnnotator(
217	1	new ServicesFactory()
218		);
219
220	1	$propertyAnnotator->setLogger(
221	1	ApplicationFactory::getInstance()->getMediaWikiLogger( 'smw-approved-revs' )
222		);
223
224	1	$propertyAnnotator->addAnnotation( $semanticData );
225
226	1	return true;
227		}
228
229		/**
230		* @see ??
231		*
232		* @since 1.0
233		*
234		* @param ParserOutput $output
235		* @param Title $title
236		* @param integer $rev_id
237		* @param string $content
238		*/
239	1	public function onApprovedRevsRevisionApproved( $output, $title, $rev_id, $content ) {
		0 ignored issues – show Unused Code introduced 2019-03-09 20:47 UTC by Report Bug Copy Issue Report The parameter `$content` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
240
241	1	$ttl = 60 * 60; // 1hr
242
243	1	if ( $this->cache === null ) {
244		$this->cache = ApplicationFactory::getInstance()->getCache();
		0 ignored issues – show Documentation Bug introduced 2019-03-09 20:47 UTC by Report Bug Copy Issue Report It seems like `\SMW\ApplicationFactory:...tInstance()->getCache()` of type `object<SMW\Cache>` is incompatible with the declared type `object<Onoi\Cache\Cache>` of property `$cache`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
245		}
246
247		// Send an event to ParserAfterTidy and allow it to pass the preliminary
248		// test even in cases where the content doesn't contain any SMW related
249		// annotations. It is to ensure that when an agent switches to a blank
250		// version (no SMW related annotations or categories) the update is carried
251		// out and the store is able to remove any remaining annotations.
252	1	$key = smwfCacheKey( 'smw:parseraftertidy', $title->getPrefixedDBKey() );
253	1	$this->cache->save( $key, $rev_id, $ttl );
254
255	1	return true;
256		}
257
258		/**
259		* @see ??
260		*
261		* @since 1.0
262		*
263		* @param Parser $parser
264		* @param Title $title
265		* @param integer $timestamp
266		* @param string $sha1
267		*/
268	1	public function onApprovedRevsFileRevisionApproved( $parser, $title, $timestamp, $sha1 ) {
269
270	1	$ttl = 60 * 60; // 1hr
271
272	1	if ( $this->cache === null ) {
273		$this->cache = ApplicationFactory::getInstance()->getCache();
		0 ignored issues – show Documentation Bug introduced 2019-03-09 20:47 UTC by Report Bug Copy Issue Report It seems like `\SMW\ApplicationFactory:...tInstance()->getCache()` of type `object<SMW\Cache>` is incompatible with the declared type `object<Onoi\Cache\Cache>` of property `$cache`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
274		}
275
276		// @see onApprovedRevsRevisionApproved for the same reason
277	1	$key = smwfCacheKey( 'smw:parseraftertidy', $title->getPrefixedDBKey() );
278	1	$this->cache->save( $key, $sha1, $ttl );
279
280	1	return true;
281		}
282
283		/**
284		* @see https://www.semantic-mediawiki.org/wiki/Hooks#...
285		*
286		* @since 1.0
287		*
288		* @param Title $title
289		* @param File &$file
290		*/
291	1	public function onChangeFile( $title, &$file ) {
292
293	1	$approvedRevsHandler = new ApprovedRevsHandler(
294	1	new ApprovedRevsFacade()
295		);
296
297	1	$approvedRevsHandler->doChangeFile( $title, $file );
298
299	1	return true;
300		}
301
302		/**
303		* @see https://www.semantic-mediawiki.org/wiki/Hooks#...
304		*
305		* @since 1.0
306		*
307		* @param Title $title
308		* @param File &$file
309		*/
310		public function onChangeFileBeforeIngestProcessComplete( $title, &$file ) {
311
312		$approvedRevsHandler = new ApprovedRevsHandler(
313		new ApprovedRevsFacade()
314		);
315
316		$approvedRevsHandler->doChangeFile( $title, $file );
317
318		return true;
319		}
320
321	2	private function registerHandlers( $config ) {
		0 ignored issues – show Unused Code introduced 2019-03-02 11:29 UTC by Report Bug Copy Issue Report The parameter `$config` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
322	2	$this->handlers = [
323	2	'ApprovedRevsRevisionApproved' => [ $this, 'onApprovedRevsRevisionApproved' ],
324	2	'ApprovedRevsFileRevisionApproved' => [ $this, 'onApprovedRevsFileRevisionApproved' ],
325	2	'SMW::RevisionGuard::IsApprovedRevision' => [ $this, 'onIsApprovedRevision' ],
326	2	'SMW::RevisionGuard::ChangeRevision' => [ $this, 'onChangeRevision' ],
327	2	'SMW::RevisionGuard::ChangeRevisionID' => [ $this, 'onOverrideRevisionID' ],
328	2	'SMW::RevisionGuard::ChangeFile' => [ $this, 'onChangeFile' ],
329	2	'SMW::Property::initProperties' => [ $this, 'onInitProperties' ],
330	2	'SMWStore::updateDataBefore' => [ $this, 'onUpdateDataBefore' ],
331		];
332	2	}
333
334		}
335

SemanticMediaWiki / SemanticApprovedRevs

Pull Request — master (#9)

Hooks::onChangeFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like