6806400129
Reasons for touching this are:
* "@param type $var" were mixed in a lot of places. Both works but the
MediaWiki coding conventions suggest that specific order.
* Things like String and Bool aren't objects and shouldn't be uppercase.
* Tried to fill missing types in "@param $var".
* Tried to fill missing descriptions in "@return type" when I could.
* Removed duplicate descriptions if a @see is sufficend.
* Removed useless descriptions ("isUsefull returns true if usefull").
* Removed useless @return void.
* Replaces mixed[] with array (does have the exact same meaning).
* Tried to find better replacements for "varargs", phpDocumentor
suggest $var,...
* Order should be @since, @param, @throws, @return, @see. This is the
order Doxygen renders this.
There is always more to do but I think this is already much better
than before. Please feel free to put more change sets on top of mine
or request more changes by adding comments.
Change-Id: I05262ce06caabf79f68772302524ac91bbead1c6
82 lines
2.2 KiB
PHP
82 lines
2.2 KiB
PHP
<?php
|
|
/**
|
|
* Portions taken from phpwiki-1.3.3.
|
|
*
|
|
* Copyright © 2000, 2001 Geoffrey T. Dairiki <dairiki@dairiki.org>
|
|
* 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 = array();
|
|
foreach ( $diff->getEdits() as $edit ) {
|
|
switch ( $edit->getType() ) {
|
|
case 'add':
|
|
foreach ( $edit->getClosing() as $line ) {
|
|
$retval[] = array(
|
|
'action' => 'add',
|
|
'new' => $line,
|
|
'newline' => $newline++
|
|
);
|
|
}
|
|
break;
|
|
case 'delete':
|
|
foreach ( $edit->getOrig() as $line ) {
|
|
$retval[] = array(
|
|
'action' => 'delete',
|
|
'old' => $line,
|
|
'oldline' => $oldline++,
|
|
);
|
|
}
|
|
break;
|
|
case 'change':
|
|
foreach ( $edit->getOrig() as $key => $line ) {
|
|
$retval[] = array(
|
|
'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;
|
|
}
|
|
|
|
}
|