PageRestorer::getUndeleteToken() - Code Metrics - addwiki/mediawiki-api - Measure and Improve Code Quality continuously with Scrutinizer

PageRestorer::getUndeleteToken() A
last analyzed 2021-02-03 19:36 UTC

↳ Parent: PageRestorer

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	18
cp	0
rs	9.6666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php

namespace Mediawiki\Api\Service;

use Mediawiki\Api\SimpleRequest;
use Mediawiki\DataModel\Page;
use Mediawiki\DataModel\Title;
use OutOfBoundsException;

/**
 * @access private
 *
 * @author Addshore
 */
class PageRestorer extends Service {

	/**
	 * @since 0.3
	 *
	 * @param Page $page
	 * @param array $extraParams
	 *
	 * @return bool
	 */
	public function restore( Page $page, array $extraParams = [] ) {
		$this->api->postRequest(
			new SimpleRequest(
				'undelete',
				$this->getUndeleteParams( $page->getTitle(), $extraParams )
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			)
		);

		return true;
	}

	/**
	 * @param Title $title
	 * @param array $extraParams
	 *
	 * @return array
	 */
	private function getUndeleteParams( Title $title, $extraParams ) {
		$params = [];

		$params['title'] = $title->getTitle();

		$params['token'] = $this->getUndeleteToken( $title );

		return array_merge( $extraParams, $params );
	}

	/**
	 * @param Title $title
	 *
	 * @throws OutOfBoundsException
	 * @return string
	 */
	private function getUndeleteToken( Title $title ) {
		$response = $this->api->postRequest(
			new SimpleRequest(
				'query', [
				'list' => 'deletedrevs',
				'titles' => $title->getTitle(),

				'drprop' => 'token',
			]
			)
		);
		if ( array_key_exists( 'token', $response['query']['deletedrevs'][0] ) ) {
			return $response['query']['deletedrevs'][0]['token'];
		} else {
			throw new OutOfBoundsException(
				'Could not get page undelete token from list=deletedrevs query'
			);
		}
	}

}


1			<?php
2
3			namespace Mediawiki\Api\Service;
4
5			use Mediawiki\Api\SimpleRequest;
6			use Mediawiki\DataModel\Page;
7			use Mediawiki\DataModel\Title;
8			use OutOfBoundsException;
9
10			/**
11			* @access private
12			*
13			* @author Addshore
14			*/
15			class PageRestorer extends Service {
16
17			/**
18			* @since 0.3
19			*
20			* @param Page $page
21			* @param array $extraParams
22			*
23			* @return bool
24			*/
25			public function restore( Page $page, array $extraParams = [] ) {
26			$this->api->postRequest(
27			new SimpleRequest(
28			'undelete',
29			$this->getUndeleteParams( $page->getTitle(), $extraParams )
			0 ignored issues – show Bug introduced 2015-12-12 15:25 UTC by Report Bug Copy Issue Report It seems like `$page->getTitle()` can be `null`; however, `getUndeleteParams()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Deprecated Code introduced 2015-12-12 15:25 UTC by Report Bug Copy Issue Report The method `Mediawiki\DataModel\Page::getTitle()` has been deprecated with message: since 0.5 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
30			)
31			);
32
33			return true;
34			}
35
36			/**
37			* @param Title $title
38			* @param array $extraParams
39			*
40			* @return array
41			*/
42			private function getUndeleteParams( Title $title, $extraParams ) {
43			$params = [];
44
45			$params['title'] = $title->getTitle();
			0 ignored issues – show Deprecated Code introduced 2015-12-12 15:25 UTC by Report Bug Copy Issue Report The method `Mediawiki\DataModel\Title::getTitle()` has been deprecated with message: in 0.6 use getText (makes things look cleaner) This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
46			$params['token'] = $this->getUndeleteToken( $title );
47
48			return array_merge( $extraParams, $params );
49			}
50
51			/**
52			* @param Title $title
53			*
54			* @throws OutOfBoundsException
55			* @return string
56			*/
57			private function getUndeleteToken( Title $title ) {
58			$response = $this->api->postRequest(
59			new SimpleRequest(
60			'query', [
61			'list' => 'deletedrevs',
62			'titles' => $title->getTitle(),
			0 ignored issues – show Deprecated Code introduced 2015-12-12 15:25 UTC by Report Bug Copy Issue Report The method `Mediawiki\DataModel\Title::getTitle()` has been deprecated with message: in 0.6 use getText (makes things look cleaner) This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
63			'drprop' => 'token',
64			]
65			)
66			);
67			if ( array_key_exists( 'token', $response['query']['deletedrevs'][0] ) ) {
68			return $response['query']['deletedrevs'][0]['token'];
69			} else {
70			throw new OutOfBoundsException(
71			'Could not get page undelete token from list=deletedrevs query'
72			);
73			}
74			}
75
76			}
77

addwiki / mediawiki-api

PageRestorer::getUndeleteToken() A last analyzed 2021-02-03 19:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PageRestorer::getUndeleteToken() A
last analyzed 2021-02-03 19:36 UTC