Download the PHP package mistralys/text-diff without Composer
On this page you can find all versions of the php package mistralys/text-diff. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mistralys/text-diff
More information about mistralys/text-diff
Files in mistralys/text-diff
Package text-diff
Short Description Class used to compare strings using a DIFF implementation.
License MIT
Informations about the package text-diff
DIFF string comparison for PHP
Class used to compare differences between two strings using a DIFF implementation, with the possibility to render the diff to HTML with highlighting.
Requirements
- PHP 8.4+
- Composer
Installation
Require via composer:
Or clone it locally via GIT, or download any of the available releases.
Usage
Comparing strings
Comparing files
Once the diff instance has been created, choose any of the toXXX
methods to retrieve the diff in your preferred format.
Important: Each
Diffinstance is single-use. All render methods (toString,toHTML,toHTMLTable,toArray) call the internal diff engine which clears itself after the first run. Only call one render method per instance; create a new instance for each render.
Changing the comparison mode
By default, the comparison will be made per line. It can be changed to be done on a per-character basis.
Pass true as the third argument to the factory method:
Or use the fluent setter on an existing instance:
HTML Highlighting
The toHTML and toHTMLTable methods support highlighting the
changes with the integrated CSS styles. To insert these, use the
Styler class: it offers several ways to access the CSS.
From here, use any of the styler's methods according to your project's needs.
For example, to show a highlighted diff with inline styles:
Releasing diff instances
When a Diff instance is no longer needed and you want to free its memory
explicitly, call dispose():
Note: Calling any render method after
dispose()will throw aDiffException. Always render before disposing.
Running the Examples
The example/ folder demonstrates every renderer — inline HTML, table HTML,
plain text, and character-level comparisons — against both inline strings
and sample text files.
Static preview (no server required)
A pre-built HTML file is included at example/dist/index.html.
Open it directly in your browser for a quick overview.
To regenerate it after making changes:
The output is written to example/dist/index.html.
Live example (PHP web server)
If you want to run the PHP version directly:
Then open http://localhost:8000/example/ in your browser.
Credits
The original Diff class was developed by Kate Morley. Compared to her version, this has been reworked extensively. The core mechanism stays the same, but updated for PHP7, and split up into subclasses to make it easier to extend and maintain. The static comparison methods are still there, but they return a diff instance now.
The original project homepage can be found here:
http://code.iamkate.com/php/diff-implementation/
Kate has since removed the library from her site, but I am keeping this here as reference.