Allow configuring escape for CsvWriter#17
Merged
Conversation
PHP 8.4 deprecates fputcsv() calls that omit the $escape argument. Add an optional constructor parameter (default '\\' for BC) and pass it through to fputcsv so callers can silence the deprecation and control escape behavior (including empty string for modern "no escape" CSV). Adds PHPUnit coverage that proves escape is applied and that writing works without deprecation exceptions under convertDeprecationsToExceptions. Supersedes #10.
Contributor
Author
|
Supersedes #10. Requesting review. |
Contributor
Author
|
@copilot please review this PR. |
Copilot stopped work on behalf of
slashrsm due to an error
July 23, 2026 08:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Supersedes #10 — rebased onto current
master(3.0.0 / PHP ^8.2) and covered with PHPUnit.PHP 8.4 deprecates
fputcsv()calls that do not pass an explicit$escapeargument. Without this change it is impossible to avoid a deprecation when usingCsvWriter(and PHPUnit withconvertDeprecationsToExceptionsfails the whole writer suite on 8.4+).Changes
$escape(typedstring, default'\\'for BC — same as Allow configuring escape forCsvWriter#10 /CsvReader)$escapeas the 5th argument to bothfputcsv()calls inwriteItem()''for the PHP-preferred modern “no escape” behaviorIf a future major bumps the default to
'', that can be done then; this keeps BC for 3.x.Tests
testEscapeParameterAffectsOutput— default\\vs''produce different CSV for a field with backslash+quote; each matches a directfputcsv()referencetestEmptyEscapeWritesWithoutDeprecation— empty escape writes multi-row CSV without PHP 8.4+ deprecation exceptionsChecklist
CsvWriter#10