A comprehensive library for generating diff between two strings.
Generated diff can be rendered in all of the standard formats including:
- Unified (Text)
- Context (Text)
- Json (Text)
- Inline (HTML)
- Side by Side (HTML)
The logic behind the core of the diff engine (i.e., the sequence matcher) is primarily based on the Python difflib package. The reason for doing so is primarily because of its high degree of accuracy.
- Some bug fixes and performance rewrites.
- UTF-8-ready.
- Follow
PSR-1,PSR-2,PSR-4. - Utilize PHP 7.1 features and make it fully type-hinted.
- Add
Jsontemplate. - Add character-level diff for HTML templates.
- Add classes
DiffHelperandRendererFactoryfor simple usage. - Add multi-language support (English, Chinese, etc...) for templates.
- PHP >= 7.1.3
- Extension:
iconv
$ composer require jfcherng/php-diff
See example/demo.php and files under tests/.
<?php
include __DIR__ . '/vendor/autoload.php';
use Jfcherng\Diff\Diff;
use Jfcherng\Diff\DiffHelper;
use Jfcherng\Diff\Utility\RendererFactory;
$old = 'This is the old string.';
$new = 'And this is the new one.';
// template class name: Unified, Context, Json, Inline, SideBySide
$template = 'Unified';
// the Diff class options
$diffOptions = [
// enable character-level diff
'charLevelDiff' => false,
// show how many neighbor lines
'context' => 3,
// ignore case difference
'ignoreCase' => false,
// ignore whitespace difference
'ignoreWhitespace' => false,
// show "..." row in HTML templates
'separateBlock' => true,
];
// the template class options
$templateOptions = [
// template language: eng, cht, chs, jpn, ...
// or an array which has the same keys with a language file
'language' => 'eng',
// HTML template tab width
'tabSize' => 4,
];
// one-line simple usage
$result = DiffHelper::calculate($old, $new, $template, $diffOptions, $templateOptions);
// or even shorter if you are happy with default options
$result = DiffHelper::calculate($old, $new, $template);
// custom usage
$diff = new Diff(explode("\n", $old), explode("\n", $new), $diffOptions);
$renderer = RendererFactory::make($template, $templateOptions);
$result = $diff->render($renderer);
@@ -1,13 +1,14 @@
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
- <title>Hello World!</title>
+ <title>Goodbye Cruel World!</title>
</head>
<body>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
- <h2>A heading we'll be removing</h2>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
+
+ <p>Just a small amount of new text...</p>
</body>
</html>***************
*** 1,13 ****
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
! <title>Hello World!</title>
</head>
<body>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
- <h2>A heading we'll be removing</h2>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</body>
</html>
--- 1,14 ----
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
! <title>Goodbye Cruel World!</title>
</head>
<body>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
+
+ <p>Just a small amount of new text...</p>
</body>
</html>
Thank you guys for sending me some cups of coffee.