| 1 |
<?php |
| 2 |
/** |
| 3 |
* Abstract class for diff renderers in PHP DiffLib. |
| 4 |
* |
| 5 |
* PHP version 5 |
| 6 |
* |
| 7 |
* Copyright (c) 2009 Chris Boulton <chris.boulton@interspire.com> |
| 8 |
* |
| 9 |
* All rights reserved. |
| 10 |
* |
| 11 |
* Redistribution and use in source and binary forms, with or without |
| 12 |
* modification, are permitted provided that the following conditions are met: |
| 13 |
* |
| 14 |
* - Redistributions of source code must retain the above copyright notice, |
| 15 |
* this list of conditions and the following disclaimer. |
| 16 |
* - Redistributions in binary form must reproduce the above copyright notice, |
| 17 |
* this list of conditions and the following disclaimer in the documentation |
| 18 |
* and/or other materials provided with the distribution. |
| 19 |
* - Neither the name of the Chris Boulton nor the names of its contributors |
| 20 |
* may be used to endorse or promote products derived from this software |
| 21 |
* without specific prior written permission. |
| 22 |
* |
| 23 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 24 |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 25 |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 26 |
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| 27 |
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 28 |
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 29 |
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 30 |
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 31 |
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 32 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 33 |
* POSSIBILITY OF SUCH DAMAGE. |
| 34 |
* |
| 35 |
* @package DiffLib |
| 36 |
* @author Chris Boulton <chris.boulton@interspire.com> |
| 37 |
* @copyright (c) 2009 Chris Boulton |
| 38 |
* @license New BSD License http://www.opensource.org/licenses/bsd-license.php |
| 39 |
* @version 1.1 |
| 40 |
* @link http://github.com/chrisboulton/php-diff |
| 41 |
*/ |
| 42 |
|
| 43 |
abstract class Diff_Renderer_Abstract |
| 44 |
{ |
| 45 |
/** |
| 46 |
* @var object Instance of the diff class that this renderer is generating the rendered diff for. |
| 47 |
*/ |
| 48 |
public $diff; |
| 49 |
|
| 50 |
/** |
| 51 |
* @var array Array of the default options that apply to this renderer. |
| 52 |
*/ |
| 53 |
protected $defaultOptions = array(); |
| 54 |
|
| 55 |
/** |
| 56 |
* @var array Array containing the user applied and merged default options for the renderer. |
| 57 |
*/ |
| 58 |
protected $options = array(); |
| 59 |
|
| 60 |
/** |
| 61 |
* The constructor. Instantiates the rendering engine and if options are passed, |
| 62 |
* sets the options for the renderer. |
| 63 |
* |
| 64 |
* @param array $options Optionally, an array of the options for the renderer. |
| 65 |
*/ |
| 66 |
public function __construct(array $options = array()) |
| 67 |
{ |
| 68 |
$this->setOptions($options); |
| 69 |
} |
| 70 |
|
| 71 |
/** |
| 72 |
* Set the options of the renderer to those supplied in the passed in array. |
| 73 |
* Options are merged with the default to ensure that there aren't any missing |
| 74 |
* options. |
| 75 |
* |
| 76 |
* @param array $options Array of options to set. |
| 77 |
*/ |
| 78 |
public function setOptions(array $options) |
| 79 |
{ |
| 80 |
$this->options = array_merge($this->defaultOptions, $options); |
| 81 |
} |
| 82 |
} |
