cvs: phpdoc /en/reference/mbstring/functions mb-list-encodings.xml
| From: | Hannes Magnusson | Date: | Thu, 27 Dec 2007 00:43:25 +0000 |
| Subject: | cvs: phpdoc /en/reference/mbstring/functions mb-list-encodings.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-858@lists.php.net to get a copy of this message | ||
bjori Thu Dec 27 00:43:25 2007 UTC
Modified files:
/phpdoc/en/reference/mbstring/functions mb-list-encodings.xml
Log:
Re-add mistakenly removed function and upgrade it to the new-doc-style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mbstring/functions/mb-list-encodings.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/mbstring/functions/mb-list-encodings.xml
diff -u /dev/null phpdoc/en/reference/mbstring/functions/mb-list-encodings.xml:1.6
--- /dev/null Thu Dec 27 00:43:25 2007
+++ phpdoc/en/reference/mbstring/functions/mb-list-encodings.xml Thu Dec 27 00:43:25 2007
@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.6 $ -->
+<refentry xml:id="function.func-name" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>mb_list_encodings</refname>
+ <refpurpose>Returns an array of all supported encodings</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>mb_list_encodings</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ Returns an array containing all supported encodings.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a numerically indexed array.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ This function does not emit any errors.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>mb_list_encodings</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+print_r(mb_list_encodings());
+
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+Array
+(
+ [0] => pass
+ [1] => auto
+ [2] => wchar
+ [3] => byte2be
+ [4] => byte2le
+ [5] => byte4be
+ [6] => byte4le
+ [7] => BASE64
+ [8] => UUENCODE
+ [9] => HTML-ENTITIES
+ [10] => Quoted-Printable
+ [11] => 7bit
+ [12] => 8bit
+ [13] => UCS-4
+ [14] => UCS-4BE
+ [15] => UCS-4LE
+ [16] => UCS-2
+ [17] => UCS-2BE
+ [18] => UCS-2LE
+ [19] => UTF-32
+ [20] => UTF-32BE
+ [21] => UTF-32LE
+ [22] => UTF-16
+ [23] => UTF-16BE
+ [24] => UTF-16LE
+ [25] => UTF-8
+ [26] => UTF-7
+ [27] => UTF7-IMAP
+ [28] => ASCII
+ [29] => EUC-JP
+ [30] => SJIS
+ [31] => eucJP-win
+ [32] => SJIS-win
+ [33] => JIS
+ [34] => ISO-2022-JP
+ [35] => Windows-1252
+ [36] => ISO-8859-1
+ [37] => ISO-8859-2
+ [38] => ISO-8859-3
+ [39] => ISO-8859-4
+ [40] => ISO-8859-5
+ [41] => ISO-8859-6
+ [42] => ISO-8859-7
+ [43] => ISO-8859-8
+ [44] => ISO-8859-9
+ [45] => ISO-8859-10
+ [46] => ISO-8859-13
+ [47] => ISO-8859-14
+ [48] => ISO-8859-15
+ [49] => EUC-CN
+ [50] => CP936
+ [51] => HZ
+ [52] => EUC-TW
+ [53] => BIG-5
+ [54] => EUC-KR
+ [55] => UHC
+ [56] => ISO-2022-KR
+ [57] => Windows-1251
+ [58] => CP866
+ [59] => KOI8-R
+)
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+