Abstract Class Diff_Renderer_Abstract

InheritanceDiff_Renderer_Abstract
SubclassesDiff_Renderer_Html_Array, Diff_Renderer_Html_Inline, Diff_Renderer_Html_SideBySide, Diff_Renderer_Text_Context, Diff_Renderer_Text_Unified

Abstract class for diff renderers in PHP DiffLib.

PHP version 5

Copyright (c) 2009 Chris Boulton chris.boulton@interspire.com

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Chris Boulton nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$diff object Instance of the diff class that this renderer is generating the rendered diff for. Diff_Renderer_Abstract

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$defaultOptions array Array of the default options that apply to this renderer. Diff_Renderer_Abstract
$options array Array containing the user applied and merged default options for the renderer. Diff_Renderer_Abstract

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() The constructor. Instantiates the rendering engine and if options are passed, sets the options for the renderer. Diff_Renderer_Abstract
setOptions() Set the options of the renderer to those supplied in the passed in array. Diff_Renderer_Abstract

Property Details

$defaultOptions protected property

Array of the default options that apply to this renderer.

protected array $defaultOptions = []
$diff public property

Instance of the diff class that this renderer is generating the rendered diff for.

public object $diff null
$options protected property

Array containing the user applied and merged default options for the renderer.

protected array $options = []

Method Details

__construct() public method

The constructor. Instantiates the rendering engine and if options are passed, sets the options for the renderer.

public void __construct ( array $options = [] )
$options array

Optionally, an array of the options for the renderer.

setOptions() public method

Set the options of the renderer to those supplied in the passed in array.

Options are merged with the default to ensure that there aren't any missing options.

public void setOptions ( array $options )
$options array

Array of options to set.