Skip to content

add details about php8.1 mb-detect-encoding unordered encodings #2426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

add details about php8.1 mb-detect-encoding unordered encodings #2426

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93a849a
add details about php8.1 being unordered
jspaetzel Apr 13, 2023
54bc98b
simplify message about exclusions
jspaetzel Apr 13, 2023
736a5cd
add comment to example
jspaetzel Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions reference/mbstring/functions/mb-detect-encoding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@
</methodsynopsis>
<para>
Detects the most likely character encoding for <type>string</type> <parameter>string</parameter>
from an ordered list of candidates.
from a list of candidates.
</para>
<para>
As of PHP 8.1 this function uses heuristics to detect which of the valid text encodings in the specified
list is most likely to be correct and may not be in order of <parameter>encodings</parameter> provided.
</para>
<para>
Automatic detection of the intended character encoding can never be entirely reliable;
Expand All @@ -27,7 +31,7 @@
<para>
This function is most useful with multibyte encodings, where not all sequences of
bytes form a valid string. If the input string contains such a sequence, that
encoding will be rejected, and the next encoding checked.
encoding will be rejected.
</para>
</refsect1>

Expand All @@ -47,7 +51,7 @@
<term><parameter>encodings</parameter></term>
<listitem>
<para>
A list of character encodings to try, in order. The list may be specified as
A list of character encodings to try. The list may be specified as
an array of strings, or a single string separated by commas.
</para>
<para>
Expand Down Expand Up @@ -174,8 +178,9 @@ string(10) "ISO-8859-1"
<?php
$str = "\xC4\xA2";

// The string is valid in all three encodings, so the first one listed will be returned
var_dump(mb_detect_encoding($str, ['UTF-8', 'ISO-8859-1', 'ISO-8859-5']));
// The string is valid in all three encodings, but the first one listed may not always be the one returned
var_dump(mb_detect_encoding($str, ['UTF-8']));
var_dump(mb_detect_encoding($str, ['UTF-8', 'ISO-8859-1', 'ISO-8859-5'])); // as of php8.1 this returns ISO-8859-1 instead of UTF-8
var_dump(mb_detect_encoding($str, ['ISO-8859-1', 'ISO-8859-5', 'UTF-8']));
var_dump(mb_detect_encoding($str, ['ISO-8859-5', 'UTF-8', 'ISO-8859-1']));
?>
Expand All @@ -186,6 +191,7 @@ var_dump(mb_detect_encoding($str, ['ISO-8859-5', 'UTF-8', 'ISO-8859-1']));
<![CDATA[
string(5) "UTF-8"
string(10) "ISO-8859-1"
string(10) "ISO-8859-1"
string(10) "ISO-8859-5"
]]>
</screen>
Expand Down