Skip to content

Commit

Permalink
Improve documentation around escape parameter deprecation
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Oct 14, 2024
1 parent 0d47043 commit 474b613
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ composer require league/csv:^9.0
## Configuration

> [!WARNING]
> **Starting with PHP8.4 Deprecation notices will be trigger if you do not explicitly use the empty string as the escape parameter.**
> **Starting with PHP8.4 Deprecation notices will be trigger if you do not explicitly set the escape parameter.**
> see [Deprecation for PHP8.4](https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_proprietary_csv_escaping_mechanism) and [CSV and PHP8.4](https://nyamsprod.com/blog/csv-and-php8-4/)
> [!TIP]
Expand Down
7 changes: 3 additions & 4 deletions docs/9.0/connections/controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,10 @@ $enclosure = $csv->getEnclosure(); //returns "|"
This is a PHP specific control character which sometimes interferes with CSV parsing and writing.
It is recommended in versions preceding `9.2.0` to never change its default value unless you do understand its usage and its consequences.

<p class="message-warning">Starting with version <code>PHP8.4</code> using this method with
anything other than the empty string will trigger a <code>PHP deprecation notice!</code>
<p class="message-warning">Starting with version <code>PHP7.4</code> it is recommended to use the library
with the escape parameter equal to the empty string.
see <a href="https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_proprietary_csv_escaping_mechanism">Deprecation for PHP8.4</a> and
<a href="https://nyamsprod.com/blog/csv-and-php8-4/">CSV and PHP8.4</a> for more information.
</p>
<a href="https://nyamsprod.com/blog/csv-and-php8-4/">CSV and PHP8.4</a> for more information.</p>

### Description

Expand Down

0 comments on commit 474b613

Please sign in to comment.