diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 11:31:45 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 11:31:45 +0000 |
commit | 4e393913a4b1f06509da4341f0f58a41adac9117 (patch) | |
tree | 9c27e3eb77d109dff5fd031502311c5616adab04 /vendor/jfcherng/php-diff/UPGRADING/UPGRADING_v6.md | |
parent | Initial commit. (diff) | |
download | icinga-php-thirdparty-4e393913a4b1f06509da4341f0f58a41adac9117.tar.xz icinga-php-thirdparty-4e393913a4b1f06509da4341f0f58a41adac9117.zip |
Adding upstream version 0.12.1+ds.upstream/0.12.1+dsupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/jfcherng/php-diff/UPGRADING/UPGRADING_v6.md')
-rw-r--r-- | vendor/jfcherng/php-diff/UPGRADING/UPGRADING_v6.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/vendor/jfcherng/php-diff/UPGRADING/UPGRADING_v6.md b/vendor/jfcherng/php-diff/UPGRADING/UPGRADING_v6.md new file mode 100644 index 0000000..8929ac4 --- /dev/null +++ b/vendor/jfcherng/php-diff/UPGRADING/UPGRADING_v6.md @@ -0,0 +1,47 @@ +## Upgrading to v6 + + +### For Simple Users + +If you only use the `DiffHelper` and built-in `Renderer`s, +there is no breaking change for you so you do not have to do anything. + + +### Breaking Changes for Normal Users + +- The `Diff` class has been renamed as `Differ`. + It should be relatively easy to adapt to this by changing the class name. + +- The term `template` has been renamed as `renderer`. Some examples are: + + - Method `DiffHelper::getRenderersInfo()` + - Method `DiffHelper::getAvailableRenderers()` + - Constant `RendererConstant::RENDERER_TYPES` + - Constant `AbstractRenderer::IS_TEXT_RENDERER` + +- Now a `Renderer` has a `render()` method, but a `Differ` does not. + (because it makes more sense saying a renderer would render something) + If you use those classes by yourself, it should be written like below. + + ```php + use Jfcherng\Diff\Differ; + use Jfcherng\Diff\Factory\RendererFactory; + + $differ = new Differ(explode("\n", $old), explode("\n", $new), $diffOptions); + $renderer = RendererFactory::make($rendererName, $rendererOptions); + $result = $renderer->render($differ); // <-- this line has been changed + ``` + + +### Breaking Changes for Customized Renderer Developers + +- Remove the deprecated `AbstractRenderer::getIdenticalResult()` and + add `RendererInterface::getResultForIdenticals()`. The returned value will be + directly used before actually starting to calculate diff if we find that the + two strings are the same. `AbstractRenderer::getResultForIdenticals()` + returns an empty string by default. + +- Now a `Renderer` should implement `protected function renderWorker(Differ $differ): string` + rather than the previous `public function render(): string`. Note that + `$this->diff` no longer works in `Renderer`s as it is now injected as a + parameter to `Renderer::renderWorker()`. |