Skip to content

ext/intl: document PHP 8.5 changes #5806

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
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
+302 −0
Open

ext/intl: document PHP 8.5 changes #5806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
117 changes: 117 additions & 0 deletions reference/intl/grapheme/grapheme-levenshtein.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.grapheme-levenshtein" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>grapheme_levenshtein</refname>
<refpurpose>Calculate the Levenshtein distance between two strings in grapheme units</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<simpara>&style.procedural;</simpara>
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>grapheme_levenshtein</methodname>
<methodparam><type>string</type><parameter>string1</parameter></methodparam>
<methodparam><type>string</type><parameter>string2</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cost_ins</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cost_rep</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cost_del</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<simpara>
Calculates the Levenshtein distance between two strings, where the distance
is measured in grapheme units rather than bytes or characters.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>string1</parameter></term>
<listitem>
<simpara>
One of the strings being evaluated for Levenshtein distance.
Must be valid UTF-8.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string2</parameter></term>
<listitem>
<simpara>
One of the strings being evaluated for Levenshtein distance.
Must be valid UTF-8.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cost_ins</parameter></term>
<listitem>
<simpara>
Defines the cost of insertion.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cost_rep</parameter></term>
<listitem>
<simpara>
Defines the cost of replacement.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cost_del</parameter></term>
<listitem>
<simpara>
Defines the cost of deletion.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
This function returns the Levenshtein-Distance between the two argument
strings (in grapheme units), or &false; if one of the argument strings is
longer than the limit of 255 grapheme units.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>levenshtein</function></member>
<member><function>grapheme_strlen</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
8 changes: 8 additions & 0 deletions reference/intl/locale.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,14 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
<classname>Locale</classname> methods now throw a
<exceptionname>ValueError</exceptionname> when a locale argument
contains null bytes.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
Expand Down
88 changes: 88 additions & 0 deletions reference/intl/locale/add-likely-subtags.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="locale.addlikelysubtags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Locale::addLikelySubtags</refname>
<refname>locale_add_likely_subtags</refname>
<refpurpose>Add likely subtags to a locale</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<simpara>
&style.oop;
</simpara>
<methodsynopsis role="Locale">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Locale::addLikelySubtags</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
</methodsynopsis>
<simpara>
&style.procedural;
</simpara>
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>locale_add_likely_subtags</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
</methodsynopsis>
<simpara>
Expands a locale tag by adding likely subtags based on the ICU locale data.
For example, <literal>en</literal> becomes <literal>en_Latn_US</literal>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<simpara>
The locale to expand.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns the locale with likely subtags added, or &false; on failure.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> when the <parameter>locale</parameter>
argument contains null bytes.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Locale::minimizeSubtags</methodname></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
89 changes: 89 additions & 0 deletions reference/intl/locale/minimize-subtags.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="locale.minimizesubtags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Locale::minimizeSubtags</refname>
<refname>locale_minimize_subtags</refname>
<refpurpose>Remove likely subtags from a locale</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<simpara>
&style.oop;
</simpara>
<methodsynopsis role="Locale">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Locale::minimizeSubtags</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
</methodsynopsis>
<simpara>
&style.procedural;
</simpara>
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>locale_minimize_subtags</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
</methodsynopsis>
<simpara>
Minimizes a locale tag by removing subtags that can be inferred using the
ICU likely subtag data. For example, <literal>en_Latn_US</literal> becomes
<literal>en</literal>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<simpara>
The locale to minimize.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns the locale with likely subtags removed, or &false; on failure.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> when the <parameter>locale</parameter>
argument contains null bytes.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Locale::addLikelySubtags</methodname></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->