Issues in ArrayDiffFormatter.php - All Issues - Inspection of "Daily Inspection: Merge "Add GENDER support to pro..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (939199)

unknown

created 2016-11-04 17:19 UTC

includes/diff/ArrayDiffFormatter.php (1 issue)

Labels

Bug 1

Severity

Minor 1

addshore 1

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
/**
 * Portions taken from phpwiki-1.3.3.
 *
 * Copyright © 2000, 2001 Geoffrey T. Dairiki <[email protected]>
 * You may copy this code freely under the conditions of the GPL.
 *
 * This program 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup DifferenceEngine
 */

/**
 * A pseudo-formatter that just passes along the Diff::$edits array
 * @ingroup DifferenceEngine
 */
class ArrayDiffFormatter extends DiffFormatter {

	/**
	 * @param Diff $diff A Diff object.
	 *
	 * @return array[] List of associative arrays, each describing a difference.
	 */
	public function format( $diff ) {
		$oldline = 1;
		$newline = 1;
		$retval = [];
		foreach ( $diff->getEdits() as $edit ) {
			switch ( $edit->getType() ) {
				case 'add':
					foreach ( $edit->getClosing() as $line ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
						$retval[] = [
							'action' => 'add',
							'new' => $line,
							'newline' => $newline++
						];
					}
					break;
				case 'delete':
					foreach ( $edit->getOrig() as $line ) {
						$retval[] = [
							'action' => 'delete',
							'old' => $line,
							'oldline' => $oldline++,
						];
					}
					break;
				case 'change':
					foreach ( $edit->getOrig() as $key => $line ) {
						$retval[] = [
							'action' => 'change',
							'old' => $line,
							'new' => $edit->getClosing( $key ),
							'oldline' => $oldline++,
							'newline' => $newline++,
						];
					}
					break;
				case 'copy':
					$oldline += count( $edit->getOrig() );
					$newline += count( $edit->getOrig() );
			}
		}

		return $retval;
	}

}


1			<?php
2			/**
3			* Portions taken from phpwiki-1.3.3.
4			*
5			* Copyright © 2000, 2001 Geoffrey T. Dairiki <[email protected]>
6			* You may copy this code freely under the conditions of the GPL.
7			*
8			* This program is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation; either version 2 of the License, or
11			* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License along
19			* with this program; if not, write to the Free Software Foundation, Inc.,
20			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21			* http://www.gnu.org/copyleft/gpl.html
22			*
23			* @file
24			* @ingroup DifferenceEngine
25			*/
26
27			/**
28			* A pseudo-formatter that just passes along the Diff::$edits array
29			* @ingroup DifferenceEngine
30			*/
31			class ArrayDiffFormatter extends DiffFormatter {
32
33			/**
34			* @param Diff $diff A Diff object.
35			*
36			* @return array[] List of associative arrays, each describing a difference.
37			*/
38			public function format( $diff ) {
39			$oldline = 1;
40			$newline = 1;
41			$retval = [];
42			foreach ( $diff->getEdits() as $edit ) {
43			switch ( $edit->getType() ) {
44			case 'add':
45			foreach ( $edit->getClosing() as $line ) {
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$edit->getClosing()` of type `array<integer,string>\|string\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
46			$retval[] = [
47			'action' => 'add',
48			'new' => $line,
49			'newline' => $newline++
50			];
51			}
52			break;
53			case 'delete':
54			foreach ( $edit->getOrig() as $line ) {
55			$retval[] = [
56			'action' => 'delete',
57			'old' => $line,
58			'oldline' => $oldline++,
59			];
60			}
61			break;
62			case 'change':
63			foreach ( $edit->getOrig() as $key => $line ) {
64			$retval[] = [
65			'action' => 'change',
66			'old' => $line,
67			'new' => $edit->getClosing( $key ),
68			'oldline' => $oldline++,
69			'newline' => $newline++,
70			];
71			}
72			break;
73			case 'copy':
74			$oldline += count( $edit->getOrig() );
75			$newline += count( $edit->getOrig() );
76			}
77			}
78
79			return $retval;
80			}
81
82			}
83

wikimedia / mediawiki

Branch — master (939199)

includes/diff/ArrayDiffFormatter.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like