FlaggedRevs - Code Metrics - MW-Peachy/Peachy - Measure and Improve Code Quality continuously with Scrutinizer

FlaggedRevs A
last analyzed 2017-08-14 21:36 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	154
rs	10
c	0
b	0
f	0
ccs	0
cts	85
cp	0
wmc	23
lcom	1
cbo	3

7 Methods

Rating	Name	Size	Complexity
A	__construct()	8	2
C	review()	50	8
C	stabilize()	52	9
A	flagconfig()	1	1
A	reviewedpages()	1	1
A	unreviewedpages()	1	1
A	oldreviewedpages()	1	1

<?php

/**
 * This file is part of Peachy MediaWiki Bot API
 *
 * Peachy is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

class FlaggedRevs {

	private $wiki;

    /**
     * @param Wiki $wikiClass
     * @throws DependencyError
     */
	function __construct( Wiki &$wikiClass ) {


		if( !array_key_exists( 'FlaggedRevs', $wikiClass->get_extensions() ) ) {
			throw new DependencyError( "FlaggedRevs", "http://www.mediawiki.org/wiki/Extension:FlaggedRevs" );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}

		$this->wiki = $wikiClass;
	}

    /**
     * @param $revid
     * @param null $reason
     * @param int $status
     * @return bool
     * @throws AssertFailure
     * @throws BadEntryError
     * @throws HookError
     * @throws LoggedOut
     * @throws MWAPIError
     */
	public function review( $revid, $reason = null, $status = 1 ) {

		if( !in_array( 'review', $this->wiki->get_userrights() ) ) {
			pecho( "User is not allowed to review revisions", PECHO_FATAL );
			return false;
		}

		$tokens = $this->wiki->get_tokens();

		if( $tokens['edit'] == '+\\' ) {
			pecho( "User has logged out.\n\n", PECHO_FATAL );
			return false;
		}

		if( mb_strlen( $reason, '8bit' ) > 255 ) {

			pecho( "Comment is over 255 bytes, the maximum allowed.\n\n", PECHO_FATAL );
			return false;
		}

		pecho( "Reviewing $revid...\n\n", PECHO_NOTICE );

		$editarray = array(
			'flag_accuracy' => $status,
			'action'        => 'review',
			'token'         => $tokens['edit'],
			'revid'         => $revid
		);

		if( !empty( $reason ) ) $editArray['comment'] = $reason;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

		if( $this->wiki->get_maxlag() ) {
			$editarray['maxlag'] = $this->wiki->get_maxlag();
		}

		Hooks::runHook( 'StartReview', array( &$editarray ) );

		$result = $this->wiki->apiQuery( $editarray, true );

		if( isset( $result['review'] ) ) {
			if( isset( $result['review']['revid'] ) ) {
				return true;
			} else {
				pecho( "Review error...\n\n" . print_r( $result['review'], true ) . "\n\n", PECHO_FATAL );
				return false;
			}
		} else {
			pecho( "Review error...\n\n" . print_r( $result, true ), PECHO_FATAL );
			return false;
		}
	}

    /**
     * @param $title
     * @param string $level
     * @param null $reason
     * @param bool|false $autoreview
     * @param bool|false $watch
     * @return bool
     * @throws AssertFailure
     * @throws BadEntryError
     * @throws HookError
     * @throws LoggedOut
     * @throws MWAPIError
     */
	public function stabilize( $title, $level = 'none', $reason = null, $autoreview = false, $watch = false ) {


		if( !in_array( 'stablesettings', $this->wiki->get_userrights() ) ) {
			pecho( "User is not allowed to change the stabilization settings", PECHO_FATAL );
			return false;
		}

		$tokens = $this->wiki->get_tokens();

		if( $tokens['edit'] == '+\\' ) {
			pecho( "User has logged out.\n\n", PECHO_FATAL );
			return false;
		}

		if( mb_strlen( $reason, '8bit' ) > 255 ) {

			pecho( "Comment is over 255 bytes, the maximum allowed.\n\n", PECHO_FATAL );
			return false;
		}

		pecho( "Stabilizing title...\n\n", PECHO_NOTICE );

		$editarray = array(
			'action'       => 'review',
			'title'        => $title,
			'token'        => $tokens['edit'],
			'protectlevel' => $level
		);

		if( $watch ) $editArray['watch'] = 'yes';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		if( !empty( $reason ) ) $editArray['reason'] = $reason;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

		if( $this->wiki->get_maxlag() ) {
			$editarray['maxlag'] = $this->wiki->get_maxlag();
		}

		Hooks::runHook( 'StartStabilize', array( &$editarray ) );

		$result = $this->wiki->apiQuery( $editarray, true );

		if( isset( $result['stabilize'] ) ) {
			if( isset( $result['stabilize']['title'] ) ) {
				return true;
			} else {
				pecho( "Stabilization error...\n\n" . print_r( $result['stabilize'], true ) . "\n\n", PECHO_FATAL );
				return false;
			}
		} else {
			pecho( "Stabilization error...\n\n" . print_r( $result, true ), PECHO_FATAL );
			return false;
		}

	}

	public function flagconfig() { }

	public function reviewedpages() { }

	public function unreviewedpages() { }

	public function oldreviewedpages() { }

}


1			<?php
2
3			/**
4			* This file is part of Peachy MediaWiki Bot API
5			*
6			* Peachy is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program. If not, see <http://www.gnu.org/licenses/>.
18			*/
19
20			class FlaggedRevs {
21
22			private $wiki;
23
24			/**
25			* @param Wiki $wikiClass
26			* @throws DependencyError
27			*/
28			function __construct( Wiki &$wikiClass ) {
			0 ignored issues – show Best Practice introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Comprehensibility Best Practice introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `__construct`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
29
30			if( !array_key_exists( 'FlaggedRevs', $wikiClass->get_extensions() ) ) {
31			throw new DependencyError( "FlaggedRevs", "http://www.mediawiki.org/wiki/Extension:FlaggedRevs" );
			0 ignored issues – show Documentation introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report `'http://www.mediawiki.or.../Extension:FlaggedRevs'` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
32			}
33
34			$this->wiki = $wikiClass;
35			}
36
37			/**
38			* @param $revid
39			* @param null $reason
40			* @param int $status
41			* @return bool
42			* @throws AssertFailure
43			* @throws BadEntryError
44			* @throws HookError
45			* @throws LoggedOut
46			* @throws MWAPIError
47			*/
48			public function review( $revid, $reason = null, $status = 1 ) {
49
50			if( !in_array( 'review', $this->wiki->get_userrights() ) ) {
51			pecho( "User is not allowed to review revisions", PECHO_FATAL );
52			return false;
53			}
54
55			$tokens = $this->wiki->get_tokens();
56
57			if( $tokens['edit'] == '+\\' ) {
58			pecho( "User has logged out.\n\n", PECHO_FATAL );
59			return false;
60			}
61
62			if( mb_strlen( $reason, '8bit' ) > 255 ) {
			0 ignored issues – show Unused Code introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report The call to `mb_strlen()` has too many arguments starting with `'8bit'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
63			pecho( "Comment is over 255 bytes, the maximum allowed.\n\n", PECHO_FATAL );
64			return false;
65			}
66
67			pecho( "Reviewing $revid...\n\n", PECHO_NOTICE );
68
69			$editarray = array(
70			'flag_accuracy' => $status,
71			'action' => 'review',
72			'token' => $tokens['edit'],
73			'revid' => $revid
74			);
75
76			if( !empty( $reason ) ) $editArray['comment'] = $reason;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report `$editArray` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$editArray = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
77
78			if( $this->wiki->get_maxlag() ) {
79			$editarray['maxlag'] = $this->wiki->get_maxlag();
80			}
81
82			Hooks::runHook( 'StartReview', array( &$editarray ) );
83
84			$result = $this->wiki->apiQuery( $editarray, true );
85
86			if( isset( $result['review'] ) ) {
87			if( isset( $result['review']['revid'] ) ) {
88			return true;
89			} else {
90			pecho( "Review error...\n\n" . print_r( $result['review'], true ) . "\n\n", PECHO_FATAL );
91			return false;
92			}
93			} else {
94			pecho( "Review error...\n\n" . print_r( $result, true ), PECHO_FATAL );
95			return false;
96			}
97			}
98
99			/**
100			* @param $title
101			* @param string $level
102			* @param null $reason
103			* @param bool\|false $autoreview
104			* @param bool\|false $watch
105			* @return bool
106			* @throws AssertFailure
107			* @throws BadEntryError
108			* @throws HookError
109			* @throws LoggedOut
110			* @throws MWAPIError
111			*/
112			public function stabilize( $title, $level = 'none', $reason = null, $autoreview = false, $watch = false ) {
			0 ignored issues – show Unused Code introduced 2017-08-14 21:36 UTC by Report Bug Copy Issue Report The parameter `$autoreview` 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...
113
114			if( !in_array( 'stablesettings', $this->wiki->get_userrights() ) ) {
115			pecho( "User is not allowed to change the stabilization settings", PECHO_FATAL );
116			return false;
117			}
118
119			$tokens = $this->wiki->get_tokens();
120
121			if( $tokens['edit'] == '+\\' ) {
122			pecho( "User has logged out.\n\n", PECHO_FATAL );
123			return false;
124			}
125
126			if( mb_strlen( $reason, '8bit' ) > 255 ) {
			0 ignored issues – show Unused Code introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report The call to `mb_strlen()` has too many arguments starting with `'8bit'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
127			pecho( "Comment is over 255 bytes, the maximum allowed.\n\n", PECHO_FATAL );
128			return false;
129			}
130
131			pecho( "Stabilizing title...\n\n", PECHO_NOTICE );
132
133			$editarray = array(
134			'action' => 'review',
135			'title' => $title,
136			'token' => $tokens['edit'],
137			'protectlevel' => $level
138			);
139
140			if( $watch ) $editArray['watch'] = 'yes';
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report `$editArray` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$editArray = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
141			if( !empty( $reason ) ) $editArray['reason'] = $reason;
			0 ignored issues – show Bug introduced 2016-01-19 16:04 UTC by Report Bug Copy Issue Report The variable `$editArray` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
142
143			if( $this->wiki->get_maxlag() ) {
144			$editarray['maxlag'] = $this->wiki->get_maxlag();
145			}
146
147			Hooks::runHook( 'StartStabilize', array( &$editarray ) );
148
149			$result = $this->wiki->apiQuery( $editarray, true );
150
151			if( isset( $result['stabilize'] ) ) {
152			if( isset( $result['stabilize']['title'] ) ) {
153			return true;
154			} else {
155			pecho( "Stabilization error...\n\n" . print_r( $result['stabilize'], true ) . "\n\n", PECHO_FATAL );
156			return false;
157			}
158			} else {
159			pecho( "Stabilization error...\n\n" . print_r( $result, true ), PECHO_FATAL );
160			return false;
161			}
162
163			}
164
165			public function flagconfig() { }
166
167			public function reviewedpages() { }
168
169			public function unreviewedpages() { }
170
171			public function oldreviewedpages() { }
172
173			}
174

MW-Peachy / Peachy

FlaggedRevs A last analyzed 2017-08-14 21:36 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

FlaggedRevs A
last analyzed 2017-08-14 21:36 UTC