Text_Diff_Renderer

Complexity

Total Complexity

37

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	4
Bugs	0	Features	1

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getParams()	0	11	3
B	_block()	0	26	6
A	_startDiff()	0	4	1
A	_endDiff()	0	4	1
B	_blockHeader()	0	11	5
A	_startBlock()	0	4	1
A	_endBlock()	0	4	1
A	_lines()	0	4	1
A	_context()	0	4	1
A	_added()	0	4	1
A	_deleted()	0	4	1
A	_changed()	0	4	1
A	__construct()	0	9	3
C	render()	0	57	11

<?php
/**
 * A class to render Diffs in different formats.
 *
 * This class renders the diff in classic diff format. It is intended that
 * this class be customized via inheritance, to obtain fancier outputs.
 *
 * $Horde: framework/Text_Diff/Diff/Renderer.php,v 1.9 2005/05/04 20:21:52 chuck Exp $
 *
 * @package Text_Diff
 */
class Text_Diff_Renderer {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

    /**
     * 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.
     */
    var $_leading_context_lines = 0;

The visibility should be declared for property $_leading_context_lines.

    /**
     * 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.
     */
    var $_trailing_context_lines = 0;

The visibility should be declared for property $_trailing_context_lines.

    /**
     * Constructor.
     */
    function __construct($params = array())

It is generally recommended to explicitly declare the visibility for methods.

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

    /**
     * Get any renderer parameters.
     *
     * @return array All parameters of this renderer object.
     */
    function getParams()

It is generally recommended to explicitly declare the visibility for methods.

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

        return $params;
    }

    /**
     * Renders a diff.
     *
     * @param Text_Diff $diff A Text_Diff object.
     *
     * @return string The formatted output.
     */
    function render($diff)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $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 (is_a($edit, '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,

The variable $x0 does not seem to be defined for all execution paths leading up to this point.

                                                 $y0, $ntrail + $yi - $y0,

The variable $y0 does not seem to be defined for all execution paths leading up to this point.

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

The expression $context of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                        $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();
    }

    function _block($xbeg, $xlen, $ybeg, $ylen, &$edits)

It is generally recommended to explicitly declare the visibility for methods.

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

    function _startDiff()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return '';
    }

    function _endDiff()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return '';
    }

    function _blockHeader($xbeg, $xlen, $ybeg, $ylen)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if ($xlen > 1) {
            $xbeg .= ',' . ($xbeg + $xlen - 1);
        }
        if ($ylen > 1) {
            $ybeg .= ',' . ($ybeg + $ylen - 1);
        }

        return $xbeg . ($xlen ? ($ylen ? 'c' : 'd') : 'a') . $ybeg;
    }

    function _startBlock($header)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $header . "\n";
    }

    function _endBlock()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return '';
    }

    function _lines($lines, $prefix = ' ')

It is generally recommended to explicitly declare the visibility for methods.

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

    function _context($lines)

It is generally recommended to explicitly declare the visibility for methods.

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

    function _added($lines)

It is generally recommended to explicitly declare the visibility for methods.

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

    function _deleted($lines)

It is generally recommended to explicitly declare the visibility for methods.

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

    function _changed($orig, $final)

It is generally recommended to explicitly declare the visibility for methods.

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

}