Text_Diff_Renderer Class Reference

Inheritance diagram for Text_Diff_Renderer:

Collaboration diagram for Text_Diff_Renderer:

Public Member Functions
	__construct ($params=array())
	Constructor. More...
	getParams ()
	Get any renderer parameters. More...
	render ($diff)
	Renders a diff. More...
	_block ($xbeg, $xlen, $ybeg, $ylen, &$edits)
	_startDiff ()
	_endDiff ()
	_blockHeader ($xbeg, $xlen, $ybeg, $ylen)
	_startBlock ($header)
	_endBlock ()
	_lines ($lines, $prefix=' ')
	_context ($lines)
	_added ($lines)
	_deleted ($lines)
	_changed ($orig, $final)

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 12 of file Renderer.php.

Constructor & Destructor Documentation

__construct()

Text_Diff_Renderer::__construct

(

$params = array()

)

Constructor.

Definition at line 34 of file Renderer.php.

    {
        foreach ($params as $param => $value) {
            $v = '_' . $param;
            if (isset($this->$v)) {
                $this->$v = $value;
            }
        }
    }

References $params.

Member Function Documentation

_added()

Text_Diff_Renderer::_added

(

$lines

)

Reimplemented in Text_Diff_Renderer_unified.

Definition at line 203 of file Renderer.php.

    {
        return $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()

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

Definition at line 134 of file Renderer.php.

    {
        $output = $this->_startBlock($this->_blockHeader($xbeg, $xlen, $ybeg, $ylen));
 
        foreach ($edits as $edit) {
            switch (strtolower(get_class($edit))) {
            case 'text_diff_op_copy':
                $output .= $this->_context($edit->orig);
                break;
 
            case 'text_diff_op_add':
                $output .= $this->_added($edit->final);
                break;
 
            case 'text_diff_op_delete':
                $output .= $this->_deleted($edit->orig);
                break;
 
            case 'text_diff_op_change':
                $output .= $this->_changed($edit->orig, $edit->final);
                break;
            }
        }
 
        return $output . $this->_endBlock();
    }

References $output, _added(), _blockHeader(), _changed(), _context(), _deleted(), _endBlock(), and _startBlock().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

_blockHeader()

Text_Diff_Renderer::_blockHeader	(		$xbeg,
			$xlen,
			$ybeg,
			$ylen
	)

Reimplemented in Text_Diff_Renderer_unified.

Definition at line 171 of file Renderer.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()

Text_Diff_Renderer::_changed	(		$orig,
			$final
	)

Reimplemented in Text_Diff_Renderer_unified.

Definition at line 213 of file Renderer.php.

    {
        return $this->_deleted($orig) . "---\n" . $this->_added($final);
    }

References $orig, _added(), and _deleted().

Referenced by _block().

Here is the call graph for this function:

Here is the caller graph for this function:

_context()

Text_Diff_Renderer::_context

(

$lines

)

Definition at line 198 of file Renderer.php.

    {
        return $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()

Text_Diff_Renderer::_deleted

(

$lines

)

Reimplemented in Text_Diff_Renderer_unified.

Definition at line 208 of file Renderer.php.

    {
        return $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:

_endBlock()

Text_Diff_Renderer::_endBlock

(

)

Definition at line 188 of file Renderer.php.

    {
        return '';
    }

Referenced by _block().

Here is the caller graph for this function:

_endDiff()

Text_Diff_Renderer::_endDiff

(

)

Definition at line 166 of file Renderer.php.

    {
        return '';
    }

Referenced by render().

Here is the caller graph for this function:

_lines()

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

Definition at line 193 of file Renderer.php.

    {
        return $prefix . implode("\n$prefix", $lines) . "\n";
    }

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

Here is the caller graph for this function:

_startBlock()

Text_Diff_Renderer::_startBlock

(

$header

)

Definition at line 183 of file Renderer.php.

    {
        return $header . "\n";
    }

References $header.

Referenced by _block().

Here is the caller graph for this function:

_startDiff()

Text_Diff_Renderer::_startDiff

(

)

Definition at line 161 of file Renderer.php.

    {
        return '';
    }

Referenced by render().

Here is the caller graph for this function:

getParams()

Text_Diff_Renderer::getParams

(

)

Get any renderer parameters.

Returns

array All parameters of this renderer object.

Definition at line 49 of file Renderer.php.

    {
        $params = array();
        foreach (get_object_vars($this) as $k => $v) {
            if ($k{0} == '_') {
                $params[substr($k, 1)] = $v;
            }
        }
 
        return $params;
    }

References $params.

render()

Text_Diff_Renderer::render

(

$diff

)

Renders a diff.

Parameters

Text_Diff

$diff

A Text_Diff object.

Returns

string The formatted output.

Definition at line 68 of file Renderer.php.

    {
        $xi = $yi = 1;
        $block = false;
        $context = array();
 
        $nlead = $this->_leading_context_lines;
        $ntrail = $this->_trailing_context_lines;
 
        $output = $this->_startDiff();
 
        foreach ($diff->getDiff() as $edit) {
            if ($edit instanceof Text_Diff_Op_copy) {
                if (is_array($block)) {
                    if (count($edit->orig) <= $nlead + $ntrail) {
                        $block[] = $edit;
                    } else {
                        if ($ntrail) {
                            $context = array_slice($edit->orig, 0, $ntrail);
                            $block[] = new Text_Diff_Op_copy($context);
                        }
                        $output .= $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, count($context) - $nlead);
                    $x0 = $xi - count($context);
                    $y0 = $yi - count($context);
                    $block = array();
                    if ($context) {
                        $block[] = new Text_Diff_Op_copy($context);
                    }
                }
                $block[] = $edit;
            }
 
            if ($edit->orig) {
                $xi += count($edit->orig);
            }
            if ($edit->final) {
                $yi += count($edit->final);
            }
        }
 
        if (is_array($block)) {
            $output .= $this->_block(
                $x0,
                $xi - $x0,
                $y0,
                $yi - $y0,
                $block
            );
        }
 
        return $output . $this->_endDiff();
    }

References $_leading_context_lines, $_trailing_context_lines, $output, _block(), _endDiff(), and _startDiff().

Here is the call graph for this function:

Field Documentation

$_leading_context_lines

Text_Diff_Renderer::$_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 21 of file Renderer.php.

Referenced by render().

$_trailing_context_lines

Text_Diff_Renderer::$_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 29 of file Renderer.php.

Referenced by render().

---

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

• Services/XHTMLValidator/validator/Text_Diff/Renderer.php