DiffFormatter Class Reference

Collaboration diagram for DiffFormatter:

Public Member Functions
	format ($diff)
	Format a diff. More...
	_block ($xbeg, $xlen, $ybeg, $ylen, $edits)
	_start_diff ()
	_end_diff ()
	_block_header ($xbeg, $xlen, $ybeg, $ylen)
	_start_block ($header)
	_end_block ()
	_lines ($lines, $prefix=' ')
	_context ($lines)
	_added ($lines)
	_deleted ($lines)
	_changed ($orig, $closing)

Data Fields
	$leading_context_lines = 0
	Number of leading context "lines" to preserve. More...
	$trailing_context_lines = 0
	Number of trailing context "lines" to preserve. More...

Detailed Description

Definition at line 831 of file class.WordLevelDiff.php.

Member Function Documentation

_added()

DiffFormatter::_added

(

$lines

)

Definition at line 993 of file class.WordLevelDiff.php.

    {
        $this->_lines($lines, '>');
    }

References _lines().

Referenced by _block(), and _changed().

Here is the call graph for this function:

Here is the caller graph for this function:

_block()

DiffFormatter::_block	(		$xbeg,
			$xlen,
			$ybeg,
			$ylen,
			$edits
	)

Definition at line 926 of file class.WordLevelDiff.php.

    {
        $fname = 'DiffFormatter::_block';
        //wfProfileIn( $fname );
        $this->_start_block($this->_block_header($xbeg, $xlen, $ybeg, $ylen));
        foreach ($edits as $edit) {
            if ($edit->type == 'copy') {
                $this->_context($edit->orig);
            } elseif ($edit->type == 'add') {
                $this->_added($edit->closing);
            } elseif ($edit->type == 'delete') {
                $this->_deleted($edit->orig);
            } elseif ($edit->type == 'change') {
                $this->_changed($edit->orig, $edit->closing);
            } else {
                throw new \RuntimeException('Unknown edit type');
            }
        }
        $this->_end_block();
        //wfProfileOut( $fname );
    }

References _added(), _block_header(), _changed(), _context(), _deleted(), _end_block(), and _start_block().

Referenced by format().

Here is the call graph for this function:

Here is the caller graph for this function:

_block_header()

DiffFormatter::_block_header	(		$xbeg,
			$xlen,
			$ybeg,
			$ylen
	)

Definition at line 960 of file class.WordLevelDiff.php.

    {
        if ($xlen > 1) {
            $xbeg .= "," . ($xbeg + $xlen - 1);
        }
        if ($ylen > 1) {
            $ybeg .= "," . ($ybeg + $ylen - 1);
        }
 
        return $xbeg . ($xlen ? ($ylen ? 'c' : 'd') : 'a') . $ybeg;
    }

Referenced by _block().

Here is the caller graph for this function:

_changed()

DiffFormatter::_changed	(		$orig,
			$closing
	)

Definition at line 1002 of file class.WordLevelDiff.php.

    {
        $this->_deleted($orig);
        echo "---\n";
        $this->_added($closing);
    }

References _added(), and _deleted().

Referenced by _block().

Here is the call graph for this function:

Here is the caller graph for this function:

_context()

DiffFormatter::_context

(

$lines

)

Definition at line 988 of file class.WordLevelDiff.php.

    {
        $this->_lines($lines);
    }

References _lines().

Referenced by _block().

Here is the call graph for this function:

Here is the caller graph for this function:

_deleted()

DiffFormatter::_deleted

(

$lines

)

Definition at line 997 of file class.WordLevelDiff.php.

    {
        $this->_lines($lines, '<');
    }

References _lines().

Referenced by _block(), and _changed().

Here is the call graph for this function:

Here is the caller graph for this function:

_end_block()

DiffFormatter::_end_block

(

)

Definition at line 977 of file class.WordLevelDiff.php.

    {
    }

Referenced by _block().

Here is the caller graph for this function:

_end_diff()

DiffFormatter::_end_diff

(

)

Definition at line 953 of file class.WordLevelDiff.php.

    {
        $val = ob_get_contents();
        ob_end_clean();
        return $val;
    }

Referenced by format().

Here is the caller graph for this function:

_lines()

DiffFormatter::_lines	(		$lines,
			$prefix = ' '
	)

Definition at line 981 of file class.WordLevelDiff.php.

    {
        foreach ($lines as $line) {
            echo "$prefix $line\n";
        }
    }

Referenced by _added(), _context(), and _deleted().

Here is the caller graph for this function:

_start_block()

DiffFormatter::_start_block

(

$header

)

Definition at line 972 of file class.WordLevelDiff.php.

    {
        echo $header;
    }

Referenced by _block().

Here is the caller graph for this function:

_start_diff()

DiffFormatter::_start_diff

(

)

Definition at line 948 of file class.WordLevelDiff.php.

    {
        ob_start();
    }

Referenced by format().

Here is the caller graph for this function:

format()

DiffFormatter::format

(

$diff

)

Format a diff.

Parameters

$diff

object A Diff object.

Returns

string The formatted output.

Definition at line 855 of file class.WordLevelDiff.php.

    {
        $fname = 'DiffFormatter::format';
        //wfProfileIn( $fname );
 
        $xi = $yi = 1;
        $block = false;
        $context = array();
 
        $nlead = $this->leading_context_lines;
        $ntrail = $this->trailing_context_lines;
 
        $this->_start_diff();
 
        foreach ($diff->edits as $edit) {
            if ($edit->type == 'copy') {
                if (is_array($block)) {
                    if (sizeof($edit->orig) <= $nlead + $ntrail) {
                        $block[] = $edit;
                    } else {
                        if ($ntrail) {
                            $context = array_slice($edit->orig, 0, $ntrail);
                            $block[] = new _DiffOp_Copy($context);
                        }
                        $this->_block(
                            $x0,
                            $ntrail + $xi - $x0,
                            $y0,
                            $ntrail + $yi - $y0,
                            $block
                        );
                        $block = false;
                    }
                }
                $context = $edit->orig;
            } else {
                if (!is_array($block)) {
                    $context = array_slice($context, sizeof($context) - $nlead);
                    $x0 = $xi - sizeof($context);
                    $y0 = $yi - sizeof($context);
                    $block = array();
                    if ($context) {
                        $block[] = new _DiffOp_Copy($context);
                    }
                }
                $block[] = $edit;
            }
 
            if ($edit->orig) {
                $xi += sizeof($edit->orig);
            }
            if ($edit->closing) {
                $yi += sizeof($edit->closing);
            }
        }
 
        if (is_array($block)) {
            $this->_block(
                $x0,
                $xi - $x0,
                $y0,
                $yi - $y0,
                $block
            );
        }
 
        $end = $this->_end_diff();
        //wfProfileOut( $fname );
        return $end;
    }

References $context, $leading_context_lines, $trailing_context_lines, _block(), _end_diff(), and _start_diff().

Here is the call graph for this function:

Field Documentation

$leading_context_lines

DiffFormatter::$leading_context_lines = 0

Number of leading context "lines" to preserve.

This should be left at zero for this class, but subclasses may want to set this to other values.

Definition at line 839 of file class.WordLevelDiff.php.

Referenced by format().

$trailing_context_lines

DiffFormatter::$trailing_context_lines = 0

Number of trailing context "lines" to preserve.

This should be left at zero for this class, but subclasses may want to set this to other values.

Definition at line 847 of file class.WordLevelDiff.php.

Referenced by format().

---

The documentation for this class was generated from the following file:

• components/ILIAS/COPage/mediawikidiff/class.WordLevelDiff.php