Add option to disable the table header #53
Comments
|
This flexibility exists in the possibility to write your own renderer or to extend the included renderers by your own class which can override any of the original methods. <?php
declare(strict_types=1);
use jblond\Diff\Renderer\Html\SideBySide;
class WackoWikiSideBySide extends SideBySide
{
/**
* Generates a string representation of the opening of a predefined table and its header with titles from options.
*
* @return string HTML code representation of a table's header.
*/
public function generateDiffHeader(): string
{
return <<<HTML
<table class="Differences DifferencesSideBySide">
<thead>
<tr>
<th colspan="4">This is my overridden header</th>
</tr>
</thead>
HTML;
}
} //$renderer = new SideBySide();
$renderer = new WackoWikiSideBySide();
echo $diff->Render($renderer);Currently the master branch includes an interface which can be implemented for writing your own renderer classes. |
|
I think we need to add those things to the documentation. |
|
Yes... that's why I suggested to enable the Wiki for this repo. |
|
I enabled the wiki. |
|
After #54 is merged, we can publish a new version, so you @vendeeglobe have the option to use a customs override function and don't to patch this any longer. |
|
@vendeeglobe You can use v2.2.0 |
I've cloned the wiki to my local machine... During next week, I will add content to it. |
|
This solutions would suffice at least for just turning off the header in HTML renderer, without excluding the possibility of having your own header. |
|
I look at that. |
|
Did you look at the wiki and discussions? All generated output can by modified as wished. |
|
Well I did. The one thing is an configuration option. The other one needs a bit more programming skills. |
|
Yes I have read the wiki and the discussion. For this special case I prefer a configuration option and not have to maintain additional code. |
|
@vendeeglobe If you eager you make create a pull request for that feature. I would be happy to merge it. |
|
I'll do my best. |
// Options for generating the diff.
$options = [
'ignoreWhitespace' => true,
'ignoreCase' => true,
'context' => 2,
'showHeader' => 0,
];
// Initialize the diff class.
$diff = new Diff($sampleA, $sampleB , $options);public function generateDiffHeader(): string
{
$html = <<<HTML
<table class="Differences DifferencesUnified">
HTML;
if ($this->options['showHeader']) {
$html .= <<<HTML
<thead>
<tr>
<th>{$this->options['title1']}</th>
<th>{$this->options['title2']}</th>
<th>Differences</th>
</tr>
</thead>
HTML;
}
return $html;
}Where should the default value be set? It seems that the option showHeader gets not merged in MainRendererAbstract class. |
|
The default options https://github.com/JBlond/php-diff/blob/master/lib/jblond/Diff.php#L60 |
|
I did, but somehow the option, default or not, did not get passed on to work in the Html renderer. |
|
Suggested option is a renderer specific option. php-diff/lib/jblond/Diff/Renderer/Html/SideBySide.php Lines 35 to 41 in ff0bb29 @JBlond Please read the email I've sent you about this issue. |
private $subOptions = [
'format' => 'html',
'insertMarkers' => ['<ins>', '</ins>'],
'deleteMarkers' => ['<del>', '</del>'],
'title1' => 'Version1',
'title2' => 'Version2',
'showHeader' => true,
];I did that, however still the default value gets not overwritten by the value provided with the $options. // Initialize the diff class.
$diff = new Diff($sampleA, $sampleB , $options); |
|
Like I said, it should be added to the options array of the subRenderer and therefor the value should be passed to the constructor of the subRenderer. // Initialize the diff class.
$diff = new Diff($sampleA, $sampleB);
// Choose Renderer.
$renderer = new SideBySide(['showHeader' => true]); |
Currently we patch php-diff class for Inline and SideBySide diff mode, because the application add its own header with additional metadata. It would be nice to disable the header for instance via via the $customOptions.
The text was updated successfully, but these errors were encountered: