DiffFormatter Class Reference

Inheritance diagram for DiffFormatter:

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 1509 of file class.WordLevelDiff.php.

Member Function Documentation

_added()

DiffFormatter::_added

(

$lines

)

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

    {

_block()

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

Definition at line 1604 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') {

_block_header()

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

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

    {
        ob_start();
    }

    public function _end_diff()
    {
        $val = ob_get_contents();
        ob_end_clean();

_changed()

DiffFormatter::_changed	(		$orig,
			$closing
	)

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

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

    public function _added($lines)

_context()

DiffFormatter::_context

(

$lines

)

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

    {

_deleted()

DiffFormatter::_deleted

(

$lines

)

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

                                  {
            echo "$prefix $line\n";
        }
    }

_end_block()

DiffFormatter::_end_block

(

)

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

                       {

_end_diff()

DiffFormatter::_end_diff

(

)

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

                   {
                trigger_error('Unknown edit type', E_USER_ERROR);
            }
        }
        $this->_end_block();

_lines()

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

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

                                             : 'd') : 'a') . $ybeg;
    }

    public function _start_block($header)

_start_block()

DiffFormatter::_start_block

(

$header

)

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

    {

_start_diff()

DiffFormatter::_start_diff

(

)

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

                                            {
                $this->_added($edit->closing);
            } elseif ($edit->type == 'delete') {
                $this->_deleted($edit->orig);

format()

DiffFormatter::format

(

$diff

)

Format a diff.

Parameters

$diff

object A Diff object.

Returns

string The formatted output.

Definition at line 1533 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);
            }
        }

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 1517 of file class.WordLevelDiff.php.

$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 1525 of file class.WordLevelDiff.php.

---

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

• Services/COPage/mediawikidiff/class.WordLevelDiff.php