| 1 |
## Upgrading to v6 |
| 2 |
|
| 3 |
|
| 4 |
### For Simple Users |
| 5 |
|
| 6 |
If you only use the `DiffHelper` and built-in `Renderer`s, |
| 7 |
there is no breaking change for you so you do not have to do anything. |
| 8 |
|
| 9 |
|
| 10 |
### Breaking Changes for Normal Users |
| 11 |
|
| 12 |
- The `Diff` class has been renamed as `Differ`. |
| 13 |
It should be relatively easy to adapt to this by changing the class name. |
| 14 |
|
| 15 |
- The term `template` has been renamed as `renderer`. Some examples are: |
| 16 |
|
| 17 |
- Method `DiffHelper::getRenderersInfo()` |
| 18 |
- Method `DiffHelper::getAvailableRenderers()` |
| 19 |
- Constant `RendererConstant::RENDERER_TYPES` |
| 20 |
- Constant `AbstractRenderer::IS_TEXT_RENDERER` |
| 21 |
|
| 22 |
- Now a `Renderer` has a `render()` method, but a `Differ` does not. |
| 23 |
(because it makes more sense saying a renderer would render something) |
| 24 |
If you use those classes by yourself, it should be written like below. |
| 25 |
|
| 26 |
```php |
| 27 |
use Jfcherng\Diff\Differ; |
| 28 |
use Jfcherng\Diff\Factory\RendererFactory; |
| 29 |
|
| 30 |
$differ = new Differ(explode("\n", $old), explode("\n", $new), $diffOptions); |
| 31 |
$renderer = RendererFactory::make($rendererName, $rendererOptions); |
| 32 |
$result = $renderer->render($differ); // <-- this line has been changed |
| 33 |
``` |
| 34 |
|
| 35 |
|
| 36 |
### Breaking Changes for Customized Renderer Developers |
| 37 |
|
| 38 |
- Remove the deprecated `AbstractRenderer::getIdenticalResult()` and |
| 39 |
add `RendererInterface::getResultForIdenticals()`. The returned value will be |
| 40 |
directly used before actually starting to calculate diff if we find that the |
| 41 |
two strings are the same. `AbstractRenderer::getResultForIdenticals()` |
| 42 |
returns an empty string by default. |
| 43 |
|
| 44 |
- Now a `Renderer` should implement `protected function renderWorker(Differ $differ): string` |
| 45 |
rather than the previous `public function render(): string`. Note that |
| 46 |
`$this->diff` no longer works in `Renderer`s as it is now injected as a |
| 47 |
parameter to `Renderer::renderWorker()`. |