php-doc-en/reference/mbstring/functions/mb-language.xml
Christoph Michael Becker 92f1b8b177 Generate ext/mbstring methodsynopses based on stubs
Closes GH-190.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352028 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-12 16:32:35 +00:00

186 lines
4.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-language" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_language</refname>
<refpurpose>Set/Get current language</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>language</parameter></term>
<listitem>
<para>
Used for encoding e-mail messages.
The valid languages are listed in the following table.
<function>mb_send_mail</function> uses this setting to encode e-mail.
</para>
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Language</entry>
<entry>Charset</entry>
<entry>Encoding</entry>
<entry>Alias</entry>
</row>
</thead>
<tbody>
<row>
<entry>German/de</entry>
<entry>ISO-8859-15</entry>
<entry>Quoted-Printable</entry>
<entry>Deutsch</entry>
</row>
<row>
<entry>English/en</entry>
<entry>ISO-8859-1</entry>
<entry>Quoted-Printable</entry>
<entry></entry>
</row>
<row>
<entry>Armenian/hy</entry>
<entry>ArmSCII-8</entry>
<entry>Quoted-Printable</entry>
<entry></entry>
</row>
<row>
<entry>Japanese/ja</entry>
<entry>ISO-2022-JP</entry>
<entry>BASE64</entry>
<entry></entry>
</row>
<row>
<entry>Korean/ko</entry>
<entry>ISO-2022-KR</entry>
<entry>BASE64</entry>
<entry></entry>
</row>
<row>
<entry>neutral</entry>
<entry>UTF-8</entry>
<entry>BASE64</entry>
<entry></entry>
</row>
<row>
<entry>Russian/ru</entry>
<entry>KOI8-R</entry>
<entry>Quoted-Printable</entry>
<entry></entry>
</row>
<row>
<entry>Turkish/tr</entry>
<entry>ISO-8859-9</entry>
<entry>Quoted-Printable</entry>
<entry></entry>
</row>
<row>
<entry>Ukrainian/ua</entry>
<entry>KOI8-U</entry>
<entry>Quoted-Printable</entry>
<entry></entry>
</row>
<row>
<entry>uni</entry>
<entry>UTF-8</entry>
<entry>BASE64</entry>
<entry>universal</entry>
</row>
<row>
<entry>Simplified Chinese/zh-cn</entry>
<entry>HZ</entry>
<entry>BASE64</entry>
<entry></entry>
</row>
<row>
<entry>Traditional Chinese/zh-tw</entry>
<entry>BIG-5</entry>
<entry>BASE64</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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 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>
<simplelist>
<member><function>mb_send_mail</function></member>
</simplelist>
</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:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->