File: iconv-get-encoding.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (92 lines) | stat: -rw-r--r-- 2,449 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/iconv.xml, last change in rev 1.1 -->
  <refentry id="function.iconv-get-encoding">
   <refnamediv>
    <refname>iconv_get_encoding</refname>
    <refpurpose>Retrieve internal configuration variables of iconv extension</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>iconv_get_encoding</methodname>
      <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>iconv_get_encoding</function> returns the current value
     of the internal configuration variable if successful,
     or &false; on failure.
    </para>

    <para>
     The value of the optional <parameter>type</parameter> can be:
     <simplelist>
      <member>all</member>
      <member>input_encoding</member>
      <member>output_encoding</member>
      <member>internal_encoding</member>
     </simplelist>
    </para>

    <para>
     If <parameter>type</parameter> is omitted or set to "all",
     <function>iconv_get_encoding</function> returns an array that
     stores all these variables.
    </para>
    <para>
     <example>
      <title><function>iconv_get_encoding</function> example</title>
      <programlisting role="php">
<![CDATA[
<pre>
<?php
iconv_set_encoding("internal_encoding", "UTF-8");
iconv_set_encoding("output_encoding", "ISO-8859-1");
var_dump(iconv_get_encoding('all'));
?>
</pre>
]]>
      </programlisting>
      <para>
       The printout of the above program will be:
      </para>
      <screen>
<![CDATA[
Array
(
    [input_encoding] => ISO-8859-1
    [output_encoding] => ISO-8859-1
    [internal_encoding] => UTF-8
)

]]>
      </screen>
     </example>
    </para>
    <para>
     See also <function>iconv_set_encoding</function> and
     <function>ob_iconv_handler</function>.
    </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
-->