cvs: phpdoc /en/functions fdf.xml mbstring.xml pdf.xml

hirokawa Sun Jan 6 21:52:21 2002 EDT Modified files: /phpdoc/en/functions fdf.xml mbstring.xml pdf.xml Log: added mb_get_info() and removed experimental sentence.

Index: phpdoc/en/functions/fdf.xml diff -u phpdoc/en/functions/fdf.xml:1.26 phpdoc/en/functions/fdf.xml:1.27 --- phpdoc/en/functions/fdf.xml:1.26 Mon Dec 24 10:01:24 2001 +++ phpdoc/en/functions/fdf.xml Sun Jan 6 21:52:21 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.26 $ --> +<!-- $Revision: 1.27 $ --> <reference id="ref.fdf"> <title>Forms Data Format functions</title> <titleabbrev>FDF</titleabbrev> @@ -306,7 +306,9 @@ <funcprototype> <funcdef>string <function>fdf_next_field_name</function></funcdef> <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> + <paramdef>string + <parameter><optional>fieldname</optional></parameter> + </paramdef> </funcprototype> </funcsynopsis> <para> @@ -316,8 +318,8 @@ if the second paramter is &null;.</para> <para> - See also <function>fdf_set_field</function>, - <function>fdf_get_field</function>.</para> + See also <function>fdf_set_value</function>, + <function>fdf_get_value</function>.</para> </refsect1> </refentry> Index: phpdoc/en/functions/mbstring.xml diff -u phpdoc/en/functions/mbstring.xml:1.18 phpdoc/en/functions/mbstring.xml:1.19 --- phpdoc/en/functions/mbstring.xml:1.18 Tue Dec 18 18:14:56 2001 +++ phpdoc/en/functions/mbstring.xml Sun Jan 6 21:52:21 2002 @@ -1,20 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.mbstring"> <title>Multi-Byte String Functions</title> <titleabbrev> Multi-Byte String </titleabbrev> <partintro> - &warn.experimental; <sect1 id="mb-intro"> <title>Introduction</title> - <warning> - <simpara> - This module is EXPERIMENTAL. Function name/API is subject to - change. Current conversion filter supports Japanese only. - </simpara> - </warning> <para> There are many languages in which all characters can be expressed by single byte. Multi-byte character codes are used to express @@ -547,7 +540,6 @@ <parameter><optional>language</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_language</function> sets language. If <parameter>language</parameter> is omitted, it returns current @@ -600,7 +592,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_parse_str</function> parses GET/POST/COOKIE data and sets global variables. Since PHP does not provide raw POST/COOKIE @@ -643,7 +634,6 @@ <parameter><optional>encoding</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_internal_encoding</function> sets internal character encoding to <parameter>encoding</parameter> If parameter is @@ -702,7 +692,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <simpara> <function>mb_http_input</function> returns result of HTTP input character encoding detection. @@ -741,7 +730,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> If <parameter>encoding</parameter> is set, <function>mb_http_output</function> sets HTTP output character @@ -781,7 +769,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_detect_order</function> sets automatic character encoding detection order to <parameter>encoding-list</parameter>. @@ -883,7 +870,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_substitute_character</function> specifies substitution character when input character encoding is invalid @@ -955,7 +941,6 @@ <paramdef>int <parameter>status</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_output_handler</function> is <function>ob_start</function> callback @@ -1029,7 +1014,6 @@ <paramdef>string <parameter>encoding</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_preferred_mime_name</function> returns MIME <literal>charset</literal> string for character encoding @@ -1068,7 +1052,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_strlen</function> returns number of characters in string <parameter>str</parameter> having character encoding @@ -1109,7 +1092,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_strpos</function> returns the numeric position of the first occurrence of <parameter>needle</parameter> in the @@ -1166,7 +1148,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_strrpos</function> returns the numeric position of the last occurrence of <parameter>needle</parameter> in the @@ -1219,7 +1200,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_substr</function> returns the portion of <parameter>str</parameter> specified by the @@ -1269,7 +1249,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_strcut</function> returns the portion of <parameter>str</parameter> specified by the @@ -1316,7 +1295,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_strwidth</function> returns width of string <parameter>str</parameter>. @@ -1370,7 +1348,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_strimwidth</function> truncates string <parameter>str</parameter> to specified @@ -1426,7 +1403,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_convert_encoding</function> converts character encoding of string <parameter>str</parameter> from @@ -1483,7 +1459,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_detect_encoding</function> detects character encoding in string <parameter>str</parameter>. It returns @@ -1546,7 +1521,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_convert_kana</function> performs "han-kaku" - "zen-kaku" conversion for string <parameter>str</parameter>. It @@ -1629,7 +1603,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_encode_mimeheader</function> converts string <parameter>str</parameter> to encoded-word for header field. @@ -1682,7 +1655,6 @@ <paramdef>string <parameter>str</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_decode_mimeheader</function> decodes encoded-word string <parameter>str</parameter> in MIME header. @@ -1711,7 +1683,6 @@ <paramdef>mixed <parameter>vars</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_convert_variables</function> convert character encoding of variables <parameter>vars</parameter> in @@ -1772,7 +1743,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_encode_numericentity</function> converts specified character codes in string <parameter>str</parameter> @@ -1857,7 +1827,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> Convert numeric string reference of string <parameter>str</parameter> in specified block to character. It @@ -1917,7 +1886,6 @@ </paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; <para> <function>mb_send_mail</function> sends email. Headers and message are converted and encoded according to @@ -1955,6 +1923,43 @@ See also <function>mail</function>, <function>mb_encode_mimeheader</function>, and <function>mb_language</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.mb-get-info"> + <refnamediv> + <refname>mb_get_info</refname> + <refpurpose>Get internal settings of mbstring</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>mb_get_info</function></funcdef> + <paramdef>string + <parameter><optional>type</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + &warn.experimental.func; + <simpara> + <function>mb_get_info</function> returns internal setting + parameter of mbstring. + </simpara> + <para> + If <parameter>type</parameter> isn't specified or is specified to + "all", an array having the elements "internal_encoding", + "http_output", "http_input", "func_overload" will be returned. + </para> + <para> + If <parameter>type</parameter> is specified for "http_output", + "http_input", "internal_encoding", "func_overload", + the specified setting parameter will be returned. + </para> + <para> + See also <function>mb_internal_encoding</function>, + <function>mb_http_output</function>. </para> </refsect1> </refentry> Index: phpdoc/en/functions/pdf.xml diff -u phpdoc/en/functions/pdf.xml:1.75 phpdoc/en/functions/pdf.xml:1.76 --- phpdoc/en/functions/pdf.xml:1.75 Thu Dec 20 16:07:53 2001 +++ phpdoc/en/functions/pdf.xml Sun Jan 6 21:52:21 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.75 $ --> +<!-- $Revision: 1.76 $ --> <reference id="ref.pdf"> <title>PDF functions </title> <titleabbrev>PDF</titleabbrev> @@ -1239,14 +1239,15 @@ <funcdef>int <function>pdf_findfont</function></funcdef> <paramdef>int <parameter>pdf object</parameter></paramdef> <paramdef>string <parameter>fontname</parameter></paramdef> - <paramdef>string <parameter>encoding^</parameter></paramdef> + <paramdef>string <parameter>encoding</parameter></paramdef> <paramdef>int <parameter>embed</parameter></paramdef> </funcprototype> </funcsynopsis> <para> Prepare a font for later use with <function>pdf_setfont</function>. The metrics will be loaded, and if embed is nonzero, the font file - will be checked, but not yet used. Encoding is one of "builtin", + will be checked, but not yet + used. <parameter>encoding</parameter> is one of "builtin", "macroman", "winansi", "host", or a user-defined encoding name, or the name of a CMap. </para>