1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-internal-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_internal_encoding</refname>
<refpurpose>Set/Get internal character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
<parameter>encoding</parameter> is the character encoding name
used for the HTTP input character encoding conversion, HTTP output
character encoding conversion, and the default character encoding
for string functions defined by the mbstring module.
You should notice that the internal encoding is totally different from the one for multibyte regex.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If <parameter>encoding</parameter> is set, then
&return.success;
In this case, the character encoding for multibyte regex is NOT changed.
If <parameter>encoding</parameter> is omitted, then
the current character encoding name is returned.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
As of PHP 8.0.0, a <classname>ValueError</classname> is thrown if the
value of <parameter>encoding</parameter> is an invalid encoding.
Prior to PHP 8.0.0, a <constant>E_WARNING</constant> was emitted instead.
</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>
Now throws a <classname>ValueError</classname> if
<parameter>encoding</parameter> is an invalid encoding.
Previously a <constant>E_WARNING</constant> was emitted instead.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mb_internal_encoding</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Set internal character encoding to UTF-8 */
mb_internal_encoding("UTF-8");
/* Display current internal character encoding */
echo mb_internal_encoding();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<!--
<refsect1 role="notes">
&reftitle.notes;
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_http_input</function></member>
<member><function>mb_http_output</function></member>
<member><function>mb_detect_order</function></member>
<member><function>mb_regex_encoding</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
-->
|