Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
phpunit-diff
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Debian PHP Team
PEAR
phpunit-diff
Commits
f130611f
Commit
f130611f
authored
7 years ago
by
SpacePossum
Committed by
Sebastian Bergmann
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
update docs
parent
be612cd5
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+73
-5
73 additions, 5 deletions
README.md
with
73 additions
and
5 deletions
README.md
+
73
−
5
View file @
f130611f
...
...
@@ -14,9 +14,12 @@ If you only need this library during development, for instance to run your proje
### Usage
#### Generating diff
The
`Differ`
class can be used to generate a textual representation of the difference between two strings:
```
php
<?php
use
SebastianBergmann\Diff\Differ
;
$differ
=
new
Differ
;
...
...
@@ -31,6 +34,76 @@ The code above yields the output below:
-foo
+bar
There are three output builders available in this package:
#### UnifiedDiffOutputBuilder
This is default builder, which generates the output close to udiff and is used by PHPUnit.
```
php
<?php
use
SebastianBergmann\Diff\Differ
;
use
SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder
;
$builder
=
new
UnifiedDiffOutputBuilder
(
"--- Original
\n
+++ New
\n
"
,
// custom header
false
// do not add line numbers to the diff
);
$differ
=
new
Differ
(
$builder
);
print
$differ
->
diff
(
'foo'
,
'bar'
);
```
#### StrictUnifiedDiffOutputBuilder
Generates (strict) Unified diff's (unidiffs) with hunks,
similar to
`diff -u`
and compatible with
`patch`
and
`git apply`
.
```
php
<?php
use
SebastianBergmann\Diff\Differ
;
use
SebastianBergmann\Diff\Output\StrictUnifiedDiffOutputBuilder
;
$builder
=
new
StrictUnifiedDiffOutputBuilder
([
'collapseRanges'
=>
true
,
// ranges of length one are rendered with the trailing `,1`
'commonLineThreshold'
=>
6
,
// number of same lines before ending a new hunk and creating a new one (if needed)
'contextLines'
=>
3
,
// like `diff: -u, -U NUM, --unified[=NUM]`, for patch/git apply compatibility best to keep at least @ 3
'fromFile'
=>
null
,
'fromFileDate'
=>
null
,
'toFile'
=>
null
,
'toFileDate'
=>
null
,
]);
$differ
=
new
Differ
(
$builder
);
print
$differ
->
diff
(
'foo'
,
'bar'
);
```
#### DiffOnlyOutputBuilder
Output only the lines that differ.
```
php
<?php
use
SebastianBergmann\Diff\Differ
;
use
SebastianBergmann\Diff\Output\DiffOnlyOutputBuilder
;
$builder
=
new
DiffOnlyOutputBuilder
(
"--- Original
\n
+++ New
\n
"
);
$differ
=
new
Differ
(
$builder
);
print
$differ
->
diff
(
'foo'
,
'bar'
);
```
#### DiffOutputBuilderInterface
You can pass any output builder to the
`Differ`
class as longs as it implements the
`DiffOutputBuilderInterface`
.
#### Parsing diff
The
`Parser`
class can be used to parse a unified diff into an object graph:
```
php
...
...
@@ -114,13 +187,8 @@ The code above yields the output below:
[type:SebastianBergmann\Diff\Line:private] => 3
[content:SebastianBergmann\Diff\Line:private] => $b = new Money(2, new Currency('EUR'));
)
)
)
)
)
)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment