sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate ext/mbstring methodsynopses based on stubs

Browse source 
Closes GH-190.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352028 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2020-12-12 16:32:35 +00:00
parent 417ea9af74
commit 92f1b8b177
56 changed files with 915 additions and 403 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
reference/mbstring/functions/mb-check-encoding.xml
View file

@ -10,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_check_encoding</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>var</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Checks if the specified byte stream is valid for the specified encoding.
If <parameter>var</parameter> is of type &array;, all keys and values are
If <parameter>value</parameter> is of type &array;, all keys and values are
validated recursively.
It is useful to prevent so-called "Invalid Encoding Attack".
</para>
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<term><parameter>value</parameter></term>
<listitem>
<para>
The byte stream or &array; to check. If it is omitted, this function checks
@ -66,10 +66,16 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>value</parameter> and <parameter>encoding</parameter> are nullable now.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
This function now also accepts an &array; as <parameter>var</parameter>.
This function now also accepts an &array; as <parameter>value</parameter>.
Formerly, only &string;s have been supported.
</entry>
</row>
@ -79,7 +85,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

25
reference/mbstring/functions/mb-chr.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-chr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_chr</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_chr</methodname>
<methodparam><type>int</type><parameter>cp</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam><type>int</type><parameter>codepoint</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
@ -26,7 +25,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cp</parameter></term>
<term><parameter>codepoint</parameter></term>
<listitem>
<para>
@ -51,6 +50,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -62,7 +78,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/mbstring/functions/mb-convert-case.xml
View file

@ -10,9 +10,9 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_case</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs case folding on a <type>string</type>, converted in the way specified by
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being converted.
@ -163,7 +163,6 @@ echo $str; // Prints Τάχιστη Αλώπηξ Βαφήσ Ψημένη Γη,
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

25
reference/mbstring/functions/mb-convert-encoding.xml
View file

@ -9,16 +9,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_convert_encoding</methodname>
<methodparam><type>mixed</type><parameter>val</parameter></methodparam>
<type class="union"><type>array</type><type>string</type><type>false</type></type><methodname>mb_convert_encoding</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>string</parameter></methodparam>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>from_encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>from_encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Converts the character encoding of <parameter>val</parameter>
Converts the character encoding of <parameter>string</parameter>
to <parameter>to_encoding</parameter>
from optionally <parameter>from_encoding</parameter>.
If <parameter>val</parameter> is an &array;, all its &string; values will be
If <parameter>string</parameter> is an &array;, all its &string; values will be
converted recursively.
</para>
</refsect1>
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>val</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The &string; or &array; being encoded.
@ -39,7 +39,7 @@
<term><parameter>to_encoding</parameter></term>
<listitem>
<para>
The type of encoding that <parameter>val</parameter> is being converted to.
The type of encoding that <parameter>string</parameter> is being converted to.
</para>
</listitem>
</varlistentry>
@ -66,7 +66,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The encoded &string; or &array;.
The encoded &string; or &array; on success, &return.falseforfailure;.
</para>
</refsect1>
@ -116,10 +116,16 @@ $str = mb_convert_encoding($str, "EUC-JP", "auto");
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>from_encoding</parameter> is nullable now.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
This function now also accepts an &array; as <parameter>val</parameter>.
This function now also accepts an &array; as <parameter>string</parameter>.
Formerly, only &string;s have been supported.
</entry>
</row>
@ -129,7 +135,6 @@ $str = mb_convert_encoding($str, "EUC-JP", "auto");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/mbstring/functions/mb-convert-kana.xml
View file

@ -10,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_kana</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"KV"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"KV"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>str</parameter>.
Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>string</parameter>.
This function is only useful for Japanese.
</para>
</refsect1>
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being converted.
@ -33,7 +33,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The conversion option.
@ -165,6 +165,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -187,7 +204,6 @@ $str = mb_convert_kana($str, "KVa");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/mbstring/functions/mb-convert-variables.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_convert_variables</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_convert_variables</methodname>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter>from_encoding</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>from_encoding</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
</methodsynopsis>
@ -102,7 +102,6 @@ $inputenc = mb_convert_variables($interenc, "ASCII,UTF-8,SJIS-win", $post1, $pos
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/mbstring/functions/mb-decode-mimeheader.xml
View file

@ -10,10 +10,10 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_decode_mimeheader</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
Decodes encoded-word <type>string</type> <parameter>str</parameter> in MIME header.
Decodes encoded-word <type>string</type> <parameter>string</parameter> in MIME header.
</para>
</refsect1>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being decoded.
@ -50,7 +50,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/mbstring/functions/mb-decode-numericentity.xml
View file

@ -10,14 +10,13 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_decode_numericentity</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>array</type><parameter>convmap</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_hex</parameter><initializer>&false;</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>array</type><parameter>map</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Convert numeric string reference of <type>string</type>
<parameter>str</parameter> in a specified block to character.
<parameter>string</parameter> in a specified block to character.
</para>
</refsect1>
@ -26,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being decoded.
@ -34,10 +33,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>convmap</parameter></term>
<term><parameter>map</parameter></term>
<listitem>
<para>
<parameter>convmap</parameter> is an <type>array</type> that specifies
<parameter>map</parameter> is an <type>array</type> that specifies
the code area to convert.
</para>
</listitem>
@ -67,11 +66,28 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><parameter>convmap</parameter> example</title>
<title><parameter>map</parameter> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -91,7 +107,7 @@ $convmap = array (
<para>
<example>
<title><parameter>convmap</parameter> example escapes JavaScript string</title>
<title><parameter>map</parameter> example escapes JavaScript string</title>
<programlisting role="php">
<![CDATA[
<?php
@ -169,7 +185,6 @@ var_dump(escape_javascript_string($msg));
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/mbstring/functions/mb-detect-encoding.xml
View file

@ -9,13 +9,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_detect_encoding</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter><initializer>mb_detect_order()</initializer></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_detect_encoding</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>encodings</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>strict</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Detects character encoding in <type>string</type> <parameter>str</parameter>.
Detects character encoding in <type>string</type> <parameter>string</parameter>.
</para>
</refsect1>
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being detected.
@ -32,15 +32,15 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding_list</parameter></term>
<term><parameter>encodings</parameter></term>
<listitem>
<para>
<parameter>encoding_list</parameter> is list of character
<parameter>encodings</parameter> is list of character
encoding. Encoding order may be specified by array or comma
separated list string.
</para>
<para>
If <parameter>encoding_list</parameter> is omitted,
If <parameter>encodings</parameter> is omitted or &null;,
detect_order is used.
</para>
</listitem>
@ -106,7 +106,6 @@ echo mb_detect_encoding($str, $ary);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/mbstring/functions/mb-detect-order.xml
View file

@ -9,12 +9,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_detect_order</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter><initializer>mb_detect_order()</initializer></methodparam>
<type class="union"><type>array</type><type>bool</type></type><methodname>mb_detect_order</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Sets the automatic character
encoding detection order to <parameter>encoding_list</parameter>.
encoding detection order to <parameter>encoding</parameter>.
</para>
</refsect1>
@ -23,15 +23,15 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>encoding_list</parameter></term>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
<parameter>encoding_list</parameter> is an <type>array</type> or
<parameter>encoding</parameter> is an <type>array</type> or
comma separated list of character encoding. See <link
linkend="mbstring.supported-encodings">supported encodings</link>.
</para>
<para>
If <parameter>encoding_list</parameter> is omitted, it returns
If <parameter>encoding</parameter> is omitted or &null;, it returns
the current character encoding detection order as array.
</para>
<para>
@ -75,6 +75,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -129,7 +146,6 @@ detect_order = UTF-8, ASCII, UTF-7
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

44
reference/mbstring/functions/mb-encode-mimeheader.xml
View file

@ -10,15 +10,15 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_encode_mimeheader</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter><initializer>mb_language()</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>transfer_encoding</parameter><initializer>"B"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>linefeed</parameter><initializer>"\r\n"</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>charset</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>transfer_encoding</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>newline</parameter><initializer>"\r\n"</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>indent</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Encodes a given <type>string</type>
<parameter>str</parameter> by the MIME header encoding scheme.
<parameter>string</parameter> by the MIME header encoding scheme.
</para>
</refsect1>
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being encoded.
@ -40,7 +40,7 @@
<listitem>
<para>
<parameter>charset</parameter> specifies the name of the character set
in which <parameter>str</parameter> is represented in. The default value
in which <parameter>string</parameter> is represented in. The default value
is determined by the current NLS setting (<literal>mbstring.language</literal>).
</para>
</listitem>
@ -57,10 +57,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>linefeed</parameter></term>
<term><parameter>newline</parameter></term>
<listitem>
<para>
<parameter>linefeed</parameter> specifies the EOL (end-of-line) marker
<parameter>newline</parameter> specifies the EOL (end-of-line) marker
with which <function>mb_encode_mimeheader</function> performs
line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> term,
the act of breaking a line longer than a certain length into multiple
@ -74,7 +74,7 @@
<listitem>
<para>
Indentation of the first line (number of characters in the header
before <parameter>str</parameter>).
before <parameter>string</parameter>).
</para>
</listitem>
</varlistentry>
@ -89,6 +89,29 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>charset</parameter> and <parameter>transfer_encoding</parameter>
are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -130,7 +153,6 @@ echo $addr;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

38
reference/mbstring/functions/mb-encode-numericentity.xml
View file

@ -10,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_encode_numericentity</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>array</type><parameter>convmap</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_hex</parameter><initializer>&false;</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>array</type><parameter>map</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>hex</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Converts
specified character codes in <type>string</type> <parameter>str</parameter>
specified character codes in <type>string</type> <parameter>string</parameter>
from character code to HTML numeric character reference.
</para>
</refsect1>
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being encoded.
@ -35,10 +35,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>convmap</parameter></term>
<term><parameter>map</parameter></term>
<listitem>
<para>
<parameter>convmap</parameter> is array specifies code area to
<parameter>map</parameter> is array specifies code area to
convert.
</para>
</listitem>
@ -50,7 +50,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>is_hex</parameter></term>
<term><parameter>hex</parameter></term>
<listitem>
<para>
Whether the returned entity reference should be in hexadecimal notation
@ -73,7 +73,7 @@
&reftitle.examples;
<para>
<example>
<title><parameter>convmap</parameter> example</title>
<title><parameter>map</parameter> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -125,6 +125,23 @@ $str = mb_encode_numericentity($str, $convmap, "sjis-win");
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -135,7 +152,6 @@ $str = mb_encode_numericentity($str, $convmap, "sjis-win");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

4
reference/mbstring/functions/mb-encoding-aliases.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>mb_encoding_aliases</methodname>
<type>array</type><methodname>mb_encoding_aliases</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
@ -100,7 +100,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -121,4 +120,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

27
reference/mbstring/functions/mb-ereg-match.xml
View file

@ -12,7 +12,7 @@
<type>bool</type><methodname>mb_ereg_match</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"msr"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
A regular expression match for a multibyte string
@ -40,7 +40,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<para>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -60,6 +60,28 @@
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> is nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
@ -77,7 +99,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

40
reference/mbstring/functions/mb-ereg-replace-callback.xml
View file

@ -10,11 +10,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_ereg_replace_callback</methodname>
<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>mb_ereg_replace_callback</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"msr"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Scans <parameter>string</parameter> for matches to
@ -74,7 +74,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<para>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -89,6 +89,8 @@
&reftitle.returnvalues;
<para>
The resultant <type>string</type> on success, or &false; on error.
If <parameter>string</parameter> is not valid for the current encoding, &null;
is returned.
</para>
</refsect1>
@ -98,6 +100,37 @@
&note.mbstring.encoding.internal;
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> is nullable now.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
The function checks whether <parameter>string</parameter> is valid for the
current encoding.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -172,7 +205,6 @@ echo mb_ereg_replace_callback(
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

29
reference/mbstring/functions/mb-ereg-replace.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_ereg_replace</methodname>
<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>mb_ereg_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replacement</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"msr"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Scans <parameter>string</parameter> for matches to
@ -54,7 +54,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<simpara>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -69,6 +69,8 @@
&reftitle.returnvalues;
<para>
The resultant <type>string</type> on success, or &false; on error.
If <parameter>string</parameter> is not valid for the current encoding, &null;
is returned.
</para>
</refsect1>
@ -84,6 +86,26 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> is nullable now.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
The function checks whether <parameter>string</parameter> is valid for the
current encoding.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
The function checks whether <parameter>string</parameter> is valid for the
current encoding.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
@ -114,7 +136,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/mbstring/functions/mb-ereg-search-getregs.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_getregs</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>mb_ereg_search_getregs</methodname>
<void/>
</methodsynopsis>
<simpara>
@ -33,7 +33,7 @@
matches, the first element will have the matched sub-string, the
second element will have the first part grouped with brackets,
the third element will have the second part grouped with
brackets, and so on. It returns &false; on error;
brackets, and so on. It returns &false; on error.
</simpara>
</refsect1>
@ -54,7 +54,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/mbstring/functions/mb-ereg-search-init.xml
View file

@ -11,8 +11,8 @@
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search_init</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"msr"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>pattern</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_ereg_search_init</function> sets
@ -45,7 +45,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<para>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -63,6 +63,30 @@
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>pattern</parameter> and <parameter>options</parameter> are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
@ -80,7 +104,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/mbstring/functions/mb-ereg-search-pos.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_pos</methodname>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"ms"</initializer></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>mb_ereg_search_pos</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>pattern</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns position and length of a matched part of the multibyte regular expression
@ -37,7 +37,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<para>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -60,6 +60,30 @@
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>pattern</parameter> and <parameter>options</parameter> are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
@ -77,7 +101,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/mbstring/functions/mb-ereg-search-regs.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_regs</methodname>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"ms"</initializer></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>mb_ereg_search_regs</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>pattern</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns the matched part of a multibyte regular expression.
@ -31,7 +31,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<para>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -54,6 +54,30 @@
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>pattern</parameter> and <parameter>options</parameter> are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
@ -71,7 +95,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/mbstring/functions/mb-ereg-search-setpos.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search_setpos</methodname>
<methodparam><type>int</type><parameter>position</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_setpos</function> sets the starting
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>position</parameter></term>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The position to set. If it is negative, it counts from the end of the string.
@ -55,7 +55,7 @@
<row>
<entry>7.1.0</entry>
<entry>
Support for negative <parameter>position</parameter>s has been added.
Support for negative <parameter>offset</parameter>s has been added.
</entry>
</row>
</tbody>
@ -80,7 +80,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/mbstring/functions/mb-ereg-search.xml
View file

@ -10,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_ereg_search</methodname>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"ms"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>pattern</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs a multibyte regular expression match for a predefined multibyte string.
@ -31,7 +31,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<para>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -54,6 +54,30 @@
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>pattern</parameter> and <parameter>options</parameter> are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
@ -71,7 +95,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

35
reference/mbstring/functions/mb-ereg.xml
View file

@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_ereg</methodname>
<type>bool</type><methodname>mb_ereg</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">regs</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">matches</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Executes the regular expression match with multibyte support.
@ -40,14 +40,14 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>regs</parameter></term>
<term><parameter>matches</parameter></term>
<listitem>
<para>
If matches are found for parenthesized substrings of
<parameter>pattern</parameter> and the function is called with the
third argument <parameter>regs</parameter>, the matches will be stored
in the elements of the array <parameter>regs</parameter>.
If no matches are found, <parameter>regs</parameter> is set to an empty
third argument <parameter>matches</parameter>, the matches will be stored
in the elements of the array <parameter>matches</parameter>.
If no matches are found, <parameter>matches</parameter> is set to an empty
array.
</para>
<para>
@ -66,13 +66,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the byte length of the matched string if a match for
<parameter>pattern</parameter> was found in <parameter>string</parameter>,
or &false; if no matches were found or an error occurred.
</para>
<para>
If the optional parameter <parameter>regs</parameter> was not passed or
the length of the matched string is <literal>0</literal>, this function returns <literal>1</literal>.
Returns whether <parameter>pattern</parameter> matches <parameter>string</parameter>.
</para>
</refsect1>
@ -87,12 +81,22 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
This function returns &true; on success now. Previously, it returned the byte length
of the matched string if a match for <parameter>pattern</parameter> was found in
<parameter>string</parameter> and <parameter>matches</parameter> was passed.
If the optional parameter <parameter>matches</parameter> was not passed or
the length of the matched string was <literal>0</literal>, this function returned <literal>1</literal>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
<function>mb_ereg</function> will now set <parameter>regs</parameter> to
<function>mb_ereg</function> will now set <parameter>matches</parameter> to
an empty <type>array</type>, if nothing matched. Formerly,
<parameter>regs</parameter> was not modified in that case.
<parameter>matches</parameter> was not modified in that case.
</entry>
</row>
</tbody>
@ -117,7 +121,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/mbstring/functions/mb-eregi-replace.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_eregi_replace</methodname>
<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>mb_eregi_replace</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>replace</parameter></methodparam>
<methodparam><type>string</type><parameter>replacement</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"msri"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Scans <parameter>string</parameter> for matches to
@ -35,7 +35,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>replace</parameter></term>
<term><parameter>replacement</parameter></term>
<listitem>
<para>
The replacement text.
@ -51,7 +51,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>options</parameter></term>
<listitem>
<simpara>
The search option. See <function>mb_regex_set_options</function> for explanation.
@ -66,6 +66,8 @@
&reftitle.returnvalues;
<para>
The resultant <type>string</type> or &false; on error.
If <parameter>string</parameter> is not valid for the current encoding, &null;
is returned.
</para>
</refsect1>
@ -81,6 +83,19 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> is nullable now.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
The function checks whether <parameter>string</parameter> is valid for the
current encoding.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
@ -111,7 +126,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

35
reference/mbstring/functions/mb-eregi.xml
View file

@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_eregi</methodname>
<type>bool</type><methodname>mb_eregi</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">regs</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">matches</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Executes the case insensitive regular expression match with multibyte support.
@ -40,14 +40,14 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>regs</parameter></term>
<term><parameter>matches</parameter></term>
<listitem>
<para>
If matches are found for parenthesized substrings of
<parameter>pattern</parameter> and the function is called with the
third argument <parameter>regs</parameter>, the matches will be stored
in the elements of the array <parameter>regs</parameter>.
If no matches are found, <parameter>regs</parameter> is set to an empty
third argument <parameter>matches</parameter>, the matches will be stored
in the elements of the array <parameter>matches</parameter>.
If no matches are found, <parameter>matches</parameter> is set to an empty
array.
</para>
<para>
@ -66,13 +66,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the byte length of the matched string if a match for
<parameter>pattern</parameter> was found in <parameter>string</parameter>,
or &false; if no matches were found or an error occurred.
</para>
<para>
If the optional parameter <parameter>regs</parameter> was not passed or
the length of the matched string is <literal>0</literal>, this function returns <literal>1</literal>.
Returns whether <parameter>pattern</parameter> matches <parameter>string</parameter>.
</para>
</refsect1>
@ -87,12 +81,22 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
This function returns &true; on success now. Previously, it returned the byte length
of the matched string if a match for <parameter>pattern</parameter> was found in
<parameter>string</parameter> and <parameter>matches</parameter> was passed.
If the optional parameter <parameter>matches</parameter> was not passed or
the length of the matched string was <literal>0</literal>, this function returned <literal>1</literal>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
<function>mb_eregi</function> will now set <parameter>regs</parameter> to
<function>mb_eregi</function> will now set <parameter>matches</parameter> to
an empty <type>array</type>, if nothing matched. Formerly,
<parameter>regs</parameter> was not modified in that case.
<parameter>matches</parameter> was not modified in that case.
</entry>
</row>
</tbody>
@ -117,7 +121,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/mbstring/functions/mb-get-info.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_get_info</methodname>
<type class="union"><type>array</type><type>string</type><type>int</type><type>false</type></type><methodname>mb_get_info</methodname>
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer>"all"</initializer></methodparam>
</methodsynopsis>
<simpara>
@ -45,7 +45,8 @@
&reftitle.returnvalues;
<para>
An <type>array</type> of type information if <parameter>type</parameter>
is not specified, otherwise a specific <parameter>type</parameter>.
is not specified, otherwise a specific <parameter>type</parameter>,
&return.falseforfailure;.
</para>
</refsect1>
@ -60,7 +61,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

34
reference/mbstring/functions/mb-http-input.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_http_input</methodname>
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer>""</initializer></methodparam>
<type class="union"><type>array</type><type>string</type><type>false</type></type><methodname>mb_http_input</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>type</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Detects the HTTP input character encoding.
@ -26,8 +26,8 @@
<listitem>
<para>
Input string specifies the input type.
"G" for GET, "P" for POST, "C" for COOKIE, "S" for string, "L" for list, and
"I" for the whole list (will return <type>array</type>).
<literal>"G"</literal> for GET, <literal>"P"</literal> for POST, <literal>"C"</literal> for COOKIE, <literal>"S"</literal> for string, <literal>"L"</literal> for list, and
<literal>"I"</literal> for the whole list (will return <type>array</type>).
If type is omitted, it returns the last input type processed.
</para>
</listitem>
@ -39,12 +39,35 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The character encoding name, as per the <parameter>type</parameter>.
The character encoding name, as per the <parameter>type</parameter>,
or an array of character encoding names, if <parameter>type</parameter> is <literal>"I"</literal>.
If <function>mb_http_input</function> does not process specified
HTTP input, it returns &false;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>type</parameter> is nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -57,7 +80,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/mbstring/functions/mb-http-output.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_http_output</methodname>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_http_output()</initializer></methodparam>
<type class="union"><type>string</type><type>bool</type></type><methodname>mb_http_output</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Set/Get the HTTP output character encoding.
@ -51,6 +51,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -63,7 +80,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/mbstring/functions/mb-internal-encoding.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_internal_encoding</methodname>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<type class="union"><type>string</type><type>bool</type></type><methodname>mb_internal_encoding</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Set/Get the internal character encoding
@ -47,7 +47,24 @@
the current character encoding name is returned.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -88,7 +105,6 @@ echo mb_internal_encoding();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

33
reference/mbstring/functions/mb-language.xml
View file

@ -9,12 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_language</methodname>
<methodparam><type>string</type><parameter>language</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>mb_language</methodname>
<void />
<type class="union"><type>string</type><type>bool</type></type><methodname>mb_language</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>language</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Set/Get the current language.
@ -131,11 +127,33 @@
If <parameter>language</parameter> is set and
<parameter>language</parameter> is valid, it returns
&true;. Otherwise, it returns &false;.
When <parameter>language</parameter> is omitted, it returns the language
When <parameter>language</parameter> is omitted or &null;, it returns the language
name as a <type>string</type>.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>language</parameter> is nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -146,7 +164,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

25
reference/mbstring/functions/mb-ord.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-ord" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_ord</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>mb_ord</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
@ -26,7 +25,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
@ -51,6 +50,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -62,7 +78,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/mbstring/functions/mb-output-handler.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_output_handler</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>status</parameter></methodparam>
</methodsynopsis>
<para>
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>contents</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The contents of the output buffer.
@ -95,7 +95,6 @@ ob_start("mb_output_handler");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/mbstring/functions/mb-parse-str.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_parse_str</methodname>
<methodparam><type>string</type><parameter>encoded_string</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">result</parameter></methodparam>
</methodsynopsis>
<para>
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>encoded_string</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The URL encoded data.
@ -89,7 +89,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/mbstring/functions/mb-preferred-mime-name.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_preferred_mime_name</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_preferred_mime_name</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
@ -37,7 +37,8 @@
&reftitle.returnvalues;
<para>
The MIME <literal>charset</literal> <type>string</type> for character encoding
<parameter>encoding</parameter>.
<parameter>encoding</parameter>,
or &false; if no charset is preferred for the given <parameter>encoding</parameter>.
</para>
</refsect1>
@ -61,7 +62,6 @@ header("Content-Type: text/html; charset=" . mb_preferred_mime_name($outputenc))
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/mbstring/functions/mb-regex-encoding.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_regex_encoding</methodname>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_regex_encoding()</initializer></methodparam>
<type class="union"><type>string</type><type>bool</type></type><methodname>mb_regex_encoding</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Set/Get character encoding for a multibyte regex.
@ -54,6 +54,7 @@
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
<row>
<entry>5.6.0</entry>
<entry>
@ -77,7 +78,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/mbstring/functions/mb-regex-set-options.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_regex_set_options</methodname>
<methodparam choice="opt"><type>string</type><parameter>options</parameter><initializer>mb_regex_set_options()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Sets the default options described by <parameter>options</parameter>
@ -131,7 +131,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The previous options. If <parameter>options</parameter> is omitted,
The previous options. If <parameter>options</parameter> is omitted or &null;,
it returns the <type>string</type> that describes the current options.
</para>
</refsect1>
@ -150,10 +150,16 @@
<row>
<entry>8.0.0</entry>
<entry>
If the parameter <parameter>options</parameter> is given, the <emphasis>previous</emphasis>
If the parameter <parameter>options</parameter> is given and not &null;, the <emphasis>previous</emphasis>
options are returned. Formerly, the <emphasis>current</emphasis> options have been returned.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> is nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
@ -171,7 +177,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

25
reference/mbstring/functions/mb-scrub.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-scrub" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_scrub</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_scrub</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
@ -26,7 +25,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
@ -51,8 +50,24 @@
</para>
</refsect1>
</refentry>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/mbstring/functions/mb-send-mail.xml
View file

@ -13,8 +13,8 @@
<methodparam><type>string</type><parameter>to</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>additional_headers</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>additional_parameter</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type></type><parameter>additional_headers</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>additional_params</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Sends email. Headers and messages are converted and encoded according
@ -97,10 +97,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_parameter</parameter></term>
<term><parameter>additional_params</parameter></term>
<listitem>
<para>
<parameter>additional_parameter</parameter> is a MTA command line
<parameter>additional_params</parameter> is a MTA command line
parameter. It is useful when setting the correct Return-Path
header when using sendmail.
</para>
@ -146,6 +146,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>additional_params</parameter> is nullable now.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
@ -171,7 +177,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/mbstring/functions/mb-str-split.xml
View file

@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>mb_str_split</methodname>
<type>array</type><methodname>mb_str_split</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>split_length</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
This function will return an array of strings, it is a version of <function>str_split</function> with support for encodings of variable character size as well as fixed-size encodings of 1,2 or 4 byte characters.
If the <parameter>split_length</parameter> parameter is specified, the string is broken down into chunks of the specified length in characters (not bytes).
If the <parameter>length</parameter> parameter is specified, the string is broken down into chunks of the specified length in characters (not bytes).
The <parameter>encoding</parameter> parameter can be optionally specified and it is good practice to do so.
</para>
</refsect1>
@ -34,7 +34,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>split_length</parameter></term>
<term><parameter>length</parameter></term>
<listitem>
<para>
If specified, each element of the returned array will be composed of multiple characters instead of a single character.
@ -57,10 +57,33 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>mb_str_split</function> returns an array of strings, &return.falseforfailure;.
<function>mb_str_split</function> returns an array of strings.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
<row>
<entry>8.0.0</entry>
<entry>
This function no longer returns &false; on failure.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -71,7 +94,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/mbstring/functions/mb-strcut.xml
View file

@ -10,10 +10,10 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strcut</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strcut</function> extracts a substring from a string similarly to
@ -30,7 +30,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being cut.
@ -43,7 +43,7 @@
<para>
If <parameter>start</parameter> is non-negative, the returned string
will start at the <parameter>start</parameter>'th <emphasis>byte</emphasis> position in
<parameter>str</parameter>, counting from zero. For instance,
<parameter>string</parameter>, counting from zero. For instance,
in the string '<literal>abcdef</literal>', the byte at
position <literal>0</literal> is '<literal>a</literal>', the
byte at position <literal>2</literal> is
@ -52,10 +52,10 @@
<para>
If <parameter>start</parameter> is negative, the returned string
will start at the <parameter>start</parameter>'th byte
counting back from the end of <parameter>str</parameter>. However, if the
counting back from the end of <parameter>string</parameter>. However, if the
magnitude of a negative <parameter>start</parameter> is greater than the
length of the string, the returned portion will start from the beginning of
<parameter>str</parameter>.
<parameter>string</parameter>.
</para>
</listitem>
</varlistentry>
@ -69,7 +69,7 @@
<para>
If <parameter>length</parameter> is negative, the returned string will
end at the <parameter>length</parameter>'th byte counting back from the
end of <parameter>str</parameter>. However, if the magnitude of a negative
end of <parameter>string</parameter>. However, if the magnitude of a negative
<parameter>length</parameter> is greater than the number of characters
after the <parameter>start</parameter> position, an empty string will
be returned.
@ -90,12 +90,29 @@
&reftitle.returnvalues;
<para>
<function>mb_strcut</function> returns the portion of
<parameter>str</parameter> specified by the
<parameter>string</parameter> specified by the
<parameter>start</parameter> and
<parameter>length</parameter> parameters.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -107,7 +124,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/mbstring/functions/mb-strimwidth.xml
View file

@ -10,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strimwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>trimmarker</parameter><initializer>&quot;&quot;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>trim_marker</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Truncates <type>string</type> <parameter>str</parameter> to specified <parameter>width</parameter>.
Truncates <type>string</type> <parameter>string</parameter> to specified <parameter>width</parameter>.
</para>
</refsect1>
@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being decoded.
@ -52,7 +52,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trimmarker</parameter></term>
<term><parameter>trim_marker</parameter></term>
<listitem>
<para>
A string that is added to the end of string
@ -73,8 +73,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The truncated <type>string</type>. If <parameter>trimmarker</parameter> is set,
<parameter>trimmarker</parameter> replaces the last chars to match the <parameter>width</parameter>.
The truncated <type>string</type>. If <parameter>trim_marker</parameter> is set,
<parameter>trim_marker</parameter> replaces the last chars to match the <parameter>width</parameter>.
</para>
</refsect1>
@ -89,6 +89,7 @@
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
<row>
<entry>7.1.0</entry>
<entry>
@ -128,7 +129,6 @@ echo mb_strimwidth("Hello World", 0, 10, "...");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/mbstring/functions/mb-stripos.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_stripos</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>mb_stripos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_stripos</function> returns the numeric position of
@ -87,6 +87,7 @@
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
<row>
<entry>7.1.0</entry>
<entry>
@ -140,7 +141,6 @@ Use the PEAR Coding Standards
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

40
reference/mbstring/functions/mb-stristr.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_stristr</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_stristr</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>before_needle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_stristr</function> finds the first occurrence of
@ -87,31 +87,22 @@
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
@ -155,7 +146,6 @@ Use the PEAR Coding Standards
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/mbstring/functions/mb-strlen.xml
View file

@ -10,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strlen</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Gets the length of a <type>string</type>.
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being checked for length.
@ -44,7 +44,7 @@
&reftitle.returnvalues;
<para>
Returns the number of characters in
<type>string</type> <parameter>str</parameter> having character encoding
<type>string</type> <parameter>string</parameter> having character encoding
<parameter>encoding</parameter>. A multi-byte character is
counted as 1.
</para>
@ -58,6 +58,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -71,7 +88,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

4
reference/mbstring/functions/mb-strpos.xml
View file

@ -13,7 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Finds position of the first occurrence of a <type>string</type> in a <type>string</type>.
@ -88,6 +88,7 @@
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
<row>
<entry>7.1.0</entry>
<entry>
@ -110,7 +111,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/mbstring/functions/mb-strrchr.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strrchr</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_strrchr</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>part</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>before_needle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strrchr</function> finds the last occurrence of
@ -44,7 +44,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>part</parameter></term>
<term><parameter>before_needle</parameter></term>
<listitem>
<para>
Determines which portion of <parameter>haystack</parameter>
@ -76,6 +76,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -88,7 +105,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

44
reference/mbstring/functions/mb-strrichr.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strrichr</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_strrichr</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>part</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>before_needle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strrichr</function> finds the last occurrence of
@ -46,7 +46,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>part</parameter></term>
<term><parameter>before_needle</parameter></term>
<listitem>
<para>
Determines which portion of <parameter>haystack</parameter>
@ -87,31 +87,22 @@
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
@ -155,7 +146,6 @@ Use the PEAR Coding Standards
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

40
reference/mbstring/functions/mb-strripos.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strripos</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>mb_strripos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strripos</function> performs multi-byte safe
@ -87,31 +87,22 @@
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
@ -155,7 +146,6 @@ Use the PEAR Coding Standards
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/mbstring/functions/mb-strrpos.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strrpos</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>mb_strrpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs a multibyte safe
@ -89,6 +89,23 @@
</note>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -101,7 +118,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

40
reference/mbstring/functions/mb-strstr.xml
View file

@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strstr</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_strstr</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>before_needle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strstr</function> finds the first occurrence of
@ -85,31 +85,22 @@
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
@ -153,7 +144,6 @@ Use the PEAR Coding Standards
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/mbstring/functions/mb-strtolower.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strtolower</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns <parameter>str</parameter>
Returns <parameter>string</parameter>
with all alphabetic characters converted to lowercase.
</para>
</refsect1>
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being lowercased.
@ -44,7 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<parameter>str</parameter> with all alphabetic characters converted to lowercase.
<parameter>string</parameter> with all alphabetic characters converted to lowercase.
</para>
</refsect1>
@ -107,7 +107,6 @@ echo $str; // Prints τάχιστη αλώπηξ βαφής ψημένη γη,
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/mbstring/functions/mb-strtoupper.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strtoupper</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns <parameter>str</parameter>
Returns <parameter>string</parameter>
with all alphabetic characters converted to uppercase.
</para>
</refsect1>
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being uppercased.
@ -44,7 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<parameter>str</parameter> with all alphabetic characters converted to uppercase.
<parameter>string</parameter> with all alphabetic characters converted to uppercase.
</para>
</refsect1>
@ -107,7 +107,6 @@ echo $str; // Prints ΤΆΧΙΣΤΗ ΑΛΏΠΗΞ ΒΑΦΉΣ ΨΗΜΈΝΗ ΓΗ,
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/mbstring/functions/mb-strwidth.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mb_strwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns the width of <type>string</type> <parameter>str</parameter>,
Returns the width of <type>string</type> <parameter>string</parameter>,
where halfwidth characters count as <literal>1</literal>, and fullwidth
characters count as <literal>2</literal>.
</para>
@ -68,7 +68,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> being decoded.
@ -88,10 +88,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The width of <type>string</type> <parameter>str</parameter>.
The width of <type>string</type> <parameter>string</parameter>.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -103,7 +120,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/mbstring/functions/mb-substitute-character.xml
View file

@ -9,13 +9,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>mb_substitute_character</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>substchar</parameter><initializer>mb_substitute_character()</initializer></methodparam>
<type class="union"><type>string</type><type>int</type><type>bool</type></type><methodname>mb_substitute_character</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type><type>null</type></type><parameter>substitute_character</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Specifies a substitution character when input character encoding is invalid
or character code does not exist in output character
encoding. Invalid characters may be substituted &null; (no output),
encoding. Invalid characters may be substituted <literal>"none"</literal> (no output),
<type>string</type> or <type>int</type> value (Unicode character code value).
</para>
<para>
@ -31,7 +31,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>substchar</parameter></term>
<term><parameter>substitute_character</parameter></term>
<listitem>
<para>
Specify the Unicode value as an <type>int</type>,
@ -65,13 +65,37 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If <parameter>substchar</parameter> is set, it returns &true; for success,
If <parameter>substitute_character</parameter> is set, it returns &true; for success,
otherwise returns &false;.
If <parameter>substchar</parameter> is not set, it returns the current
If <parameter>substitute_character</parameter> is not set, it returns the current
setting.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Passing an empty string to <parameter>substitute_character</parameter>
is no longer supported; <literal>"none"</literal> should be passed instead.
</entry>
</row>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -96,7 +120,6 @@ echo mb_substitute_character();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/mbstring/functions/mb-substr-count.xml
View file

@ -12,7 +12,7 @@
<type>int</type><methodname>mb_substr_count</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Counts the number of times the
@ -60,6 +60,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -88,7 +105,6 @@ echo mb_substr_count("This is a test", "is"); // prints out 2
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/mbstring/functions/mb-substr.xml
View file

@ -10,17 +10,17 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_substr</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs a multi-byte safe
<function>substr</function> operation based on
number of characters. Position is
counted from the beginning of
<parameter>str</parameter>. First character's position is
<parameter>string</parameter>. First character's position is
0. Second character position is 1, and so on.
</para>
</refsect1>
@ -30,7 +30,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The <type>string</type> to extract the substring from.
@ -43,7 +43,7 @@
<para>
If <parameter>start</parameter> is non-negative, the returned string
will start at the <parameter>start</parameter>'th position in
<parameter>str</parameter>, counting from zero. For instance,
<parameter>string</parameter>, counting from zero. For instance,
in the string '<literal>abcdef</literal>', the character at
position <literal>0</literal> is '<literal>a</literal>', the
character at position <literal>2</literal> is
@ -52,7 +52,7 @@
<para>
If <parameter>start</parameter> is negative, the returned string
will start at the <parameter>start</parameter>'th character
from the end of <parameter>str</parameter>.
from the end of <parameter>string</parameter>.
</para>
</listitem>
</varlistentry>
@ -60,7 +60,7 @@
<term><parameter>length</parameter></term>
<listitem>
<para>
Maximum number of characters to use from <parameter>str</parameter>. If
Maximum number of characters to use from <parameter>string</parameter>. If
omitted or <literal>NULL</literal> is passed, extract all characters to
the end of the string.
</para>
@ -80,12 +80,29 @@
&reftitle.returnvalues;
<para>
<function>mb_substr</function> returns the portion of
<parameter>str</parameter> specified by the
<parameter>string</parameter> specified by the
<parameter>start</parameter> and
<parameter>length</parameter> parameters.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@ -97,7 +114,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml