cvs: phpdoc /en/functions mbstring.xml wddx.xml

hirokawa Sat Mar 9 18:32:07 2002 EDT Modified files: /phpdoc/en/functions mbstring.xml wddx.xml Log: added functions for multibyte regular expression.

Index: phpdoc/en/functions/mbstring.xml diff -u phpdoc/en/functions/mbstring.xml:1.22 phpdoc/en/functions/mbstring.xml:1.23 --- phpdoc/en/functions/mbstring.xml:1.22 Sat Feb 2 10:55:09 2002 +++ phpdoc/en/functions/mbstring.xml Sat Mar 9 18:32:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <reference id="ref.mbstring"> <title>Multi-Byte String Functions</title> <titleabbrev>Multi-Byte String</titleabbrev> @@ -1849,6 +1849,613 @@ </para> </refsect1> </refentry> + + <refentry id="function.mb-regex-encoding"> + <refnamediv> + <refname>mb_regex_encoding</refname> + <refpurpose> + Returns current encoding for multibyte regex as string + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mb_regex_encoding</methodname> + <methodparam choice="opt"> + <type>string</type><parameter>encoding</parameter> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_regex_encoding</function> returns the character + encoding used by multibyte regex functions. + </simpara> + <para> + If the optional parameter <parameter>encoding</parameter> is + specified, it is set to the character encoding for multibyte + regex. The default value is the internal character encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_internal_encoding</function>, + <function>mb_ereg</function> + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg"> + <refnamediv> + <refname>mb_ereg</refname> + <refpurpose>Regular expression match with multibyte support</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</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>regs</parameter> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg</function> executes the regular expression + match with multibyte support, and returns 1 if matches are found. + If the optional third parameter was specified, the function + returns the byte length of matched part, and therarray + <parameter>regs</parameter> will contain the substring of matched + string. The functions returns 1 if it matches with the empty + string. It no matche found or error happend, &false; will be + returned. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_eregi</function> + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-eregi"> + <refnamediv> + <refname>mb_eregi</refname> + <refpurpose> + Regular expression match ignoring case with multibyte support + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</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>regs</parameter> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_eregi</function> executes the regular expression + match with multibyte support, and returns 1 if matches are found. + This function ignore case. + If the optional third parameter was specified, the function + returns the byte length of matched part, and therarray + <parameter>regs</parameter> will contain the substring of matched + string. The functions returns 1 if it matches with the empty + string. It no matche found or error happend, &false; will be + returned. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-replace"> + <refnamediv> + <refname>mb_ereg_replace</refname> + <refpurpose>Replace regular expression with multibyte support</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</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>array</type><parameter>option</parameter> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_replace</function> scans + <parameter>string</parameter> for matches to + <parameter>pattern</parameter>, then replaces the matched text + with <parameter>replacement</parameter> and returns the result + string or &false; on error. Multibyte character can be used in + <parameter>pattern</parameter>. + </simpara> + <simpara> + Matching condition can be set by <parameter>option</parameter> + parameter. If <literal>i</literal> is specified for this + parameter, the case will be ignored. If <literal>x</literal> is + specified, white space will be ignored. If <literal>m</literal> + is specified, match will be executed in multiline mode and line + break will be included in '.'. If <literal>p</literal> is + specified, match will be executed in POSIX mode, line break + will be considered as normal character. If <literal>e</literal> + is specified, <parameter>replacement</parameter> string will be + evaluated as PHP expression. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_eregi_replace</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-eregi-replace"> + <refnamediv> + <refname>mb_eregi_replace</refname> + <refpurpose> + Replace regular expression with multibyte support + ignoring case + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</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>string</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_replace</function> scans + <parameter>string</parameter> for matches to + <parameter>pattern</parameter>, then replaces the matched text + with <parameter>replacement</parameter> and returns the result + string or &false; on error. Multibyte character can be used in + <parameter>pattern</parameter>. The case will be ignored. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_replace</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-split"> + <refnamediv> + <refname>mb_split</refname> + <refpurpose>Split multibyte string using regular expression</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mb_split</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"> + <type>int</type><parameter>limit</parameter> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_split</function> split multibyte + <parameter>string</parameter> using regular expression + <parameter>pattern</parameter> and returns the result as an + array. + </simpara> + <simpara> + If optional parameter <parameter>limit</parameter> is specified, + it will be split in <parameter>limit</parameter> elements as + maximum. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-match"> + <refnamediv> + <refname>mb_ereg_match</refname> + <refpurpose> + Regular expression match for multibyte string + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <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> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_match</function> returns &true; if + <parameter>string</parameter> matches regular expression + <parameter>pattern</parameter>, &false; if not. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search"> + <refnamediv> + <refname>mb_ereg_search</refname> + <refpurpose> + Multibyte regular expression match for predefined multibyte string + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search</function> returns &true; if the + multibyte string matches with the regular expression, &false; for + otherwise. The string for matching is set by + <function>mb_ereg_search_init</function>. If + <parameter>pattern</parameter> is not specified, the previous one + is used. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_init</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search-pos"> + <refnamediv> + <refname>mb_ereg_search_pos</refname> + <refpurpose> + Return position and length of matched part of multibyte regular + expression for predefined multibyte string + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search_pos</function> returns an array including + position of matched part for multibyte regular expression. + The first element of the array will be the beggining of matched + part, the second element will be length (bytes) of matched part. + It returns &false; on error. + </simpara> + <para> + The string for match is specified by + <function>mb_ereg_search_init</function>. It it is not specified, + the previous one will be used. + </para> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_init</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search-regs"> + <refnamediv> + <refname>mb_ereg_search_regs</refname> + <refpurpose> + Returns the matched part of multibyte regular expression + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search_regs</function> executes the multibyte + regular expression match, and if there are some matched part, it + returns an array including substring of matched part as first + element, the first grouped part with brackets as second element, + the second grouped part as third element, and so on. It returns + &false; on error. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_init</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search-init"> + <refnamediv> + <refname>mb_ereg_search_init</refname> + <refpurpose> + Setup string and regular expression for multibyte regular + expression match + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</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> + </methodparam> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search_init</function> sets + <parameter>string</parameter> and <parameter>pattern</parameter> + for multibyte regular expression. These values are used for + <function>mb_ereg_search</function>, + <function>mb_ereg_search_pos</function>, + <function>mb_ereg_search_regs</function>. It returns &true; for + success, &false; for error. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_regs</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search-getregs"> + <refnamediv> + <refname>mb_ereg_search_getregs</refname> + <refpurpose> + Retrive the result from the last multibyte regular expression + match + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mb_ereg_search_getregs</methodname> + <void/> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search_getregs</function> returns an array + including the sub-string of matched part by last + <function>mb_ereg_search</function>, + <function>mb_ereg_search_pos</function>, + <function>mb_ereg_search_regs</function>. If there are some + maches, 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; + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_init</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search-getpos"> + <refnamediv> + <refname>mb_ereg_search_getpos</refname> + <refpurpose> + Returns start point for next regular expression match + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mb_ereg_search_getpos</methodname> + <void/> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search_getpos</function> returns + the point to start regular expression match for + <function>mb_ereg_search</function>, + <function>mb_ereg_search_pos</function>, + <function>mb_ereg_search_regs</function>. The position is + represented by bytes from the head of string. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_setpos</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-ereg-search-setpos"> + <refnamediv> + <refname>mb_ereg_search_setpos</refname> + <refpurpose> + Set start point of next regular expression match + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mb_ereg_search_setpos</methodname> + <void/> + </methodsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_ereg_search_setpos</function> sets the starting + point of match for <function>mb_ereg_search</function>. + </simpara> + <para> + The internal encoding or the character encoding specified in + <function>mb_regex_encoding</function> will be used as character + encoding. + </para> + <note> + <para> + This function is supported in PHP 4.2.0 or higher. + </para> + </note> + <para> + See also: <function>mb_regex_encoding</function>, + <function>mb_ereg_search_init</function>. + </para> + </refsect1> + </refentry> </reference> Index: phpdoc/en/functions/wddx.xml diff -u phpdoc/en/functions/wddx.xml:1.19 phpdoc/en/functions/wddx.xml:1.20 --- phpdoc/en/functions/wddx.xml:1.19 Sat Feb 2 10:36:10 2002 +++ phpdoc/en/functions/wddx.xml Sat Mar 9 18:32:07 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.19 $ --> +<!-- $Revision: 1.20 $ --> <reference id="ref.wddx"> <title>WDDX Functions</title> <titleabbrev>WDDX</titleabbrev> @@ -132,7 +132,7 @@ </para> <para> <example> - <title>wddx_serialize_vars example</title> + <title><function>wddx_serialize_vars</function> example</title> <programlisting> <![CDATA[ <?php