WS, prepare for new doc style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228828 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-02-03 05:34:30 +00:00
parent 089fb1eb4e
commit d6e69825f6
11 changed files with 653 additions and 676 deletions

View file

@ -1,42 +1,41 @@
<?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>
<!-- $Revision: 1.9 $ -->
<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>
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">
<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
@ -46,11 +45,11 @@ var_dump(iconv_get_encoding('all'));
?>
</pre>
]]>
</programlisting>
<para>
The printout of the above program will be:
</para>
<screen>
</programlisting>
<para>
The printout of the above program will be:
</para>
<screen>
<![CDATA[
Array
(
@ -60,15 +59,15 @@ Array
)
]]>
</screen>
</example>
</para>
<para>
See also <function>iconv_set_encoding</function> and
<function>ob_iconv_handler</function>.
</para>
</refsect1>
</refentry>
</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:

View file

@ -1,87 +1,85 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.11 $ -->
<refentry id="function.iconv-mime-decode-headers">
<refnamediv>
<refname>iconv_mime_decode_headers</refname>
<refpurpose>
Decodes multiple <literal>MIME</literal> header fields at once
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>iconv_mime_decode_headers</methodname>
<methodparam><type>string</type><parameter>encoded_headers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.12 $ -->
<refentry id="function.iconv-mime-decode-headers">
<refnamediv>
<refname>iconv_mime_decode_headers</refname>
<refpurpose>Decodes multiple <literal>MIME</literal> header fields at once</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>iconv_mime_decode_headers</methodname>
<methodparam><type>string</type><parameter>encoded_headers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array that holds a whole set of
<literal>MIME</literal> header fields specified by
<parameter>encoded_headers</parameter> on success, or &false;
if an error occurs during the decoding.
</para>
<para>
Returns an associative array that holds a whole set of
<literal>MIME</literal> header fields specified by
<parameter>encoded_headers</parameter> on success, or &false;
if an error occurs during the decoding.
</para>
<para>
Each key of the return value represents an individual
field name and the corresponding element represents a field value.
If more than one field of the same name are present,
<function>iconv_mime_decode_headers</function> automatically incorporates
them into a numerically indexed array in the order of occurrence.
</para>
<para>
Each key of the return value represents an individual
field name and the corresponding element represents a field value.
If more than one field of the same name are present,
<function>iconv_mime_decode_headers</function> automatically incorporates
them into a numerically indexed array in the order of occurrence.
</para>
<para>
<parameter>mode</parameter> determines the behaviour in the event
<function>iconv_mime_decode_headers</function> encounters a malformed
<literal>MIME</literal> header field. You can specify any combination
of the following bitmasks.
<table>
<title>Bitmasks acceptable to <function>iconv_mime_decode_headers</function></title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>ICONV_MIME_DECODE_STRICT</entry>
<entry>
If set, the given header is decoded in full conformance with the
standards defined in <ulink url="&url.rfc;2047">RFC2047</ulink>.
This option is disabled by default because there are a lot of
broken mail user agents that don't follow the specification and don't
produce correct <literal>MIME</literal> headers.
</entry>
</row>
<row>
<entry>2</entry>
<entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
<entry>
If set, <function>iconv_mime_decode_headers</function>
attempts to ignore any grammatical errors and continue to process
a given header.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<parameter>mode</parameter> determines the behaviour in the event
<function>iconv_mime_decode_headers</function> encounters a malformed
<literal>MIME</literal> header field. You can specify any combination
of the following bitmasks.
<table>
<title>Bitmasks acceptable to <function>iconv_mime_decode_headers</function></title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>ICONV_MIME_DECODE_STRICT</entry>
<entry>
If set, the given header is decoded in full conformance with the
standards defined in <ulink url="&url.rfc;2047">RFC2047</ulink>.
This option is disabled by default because there are a lot of
broken mail user agents that don't follow the specification and don't
produce correct <literal>MIME</literal> headers.
</entry>
</row>
<row>
<entry>2</entry>
<entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
<entry>
If set, <function>iconv_mime_decode_headers</function>
attempts to ignore any grammatical errors and continue to process
a given header.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The optional <parameter>charset</parameter> parameter specifies the
character set to represent the result by. If omitted,
<link linkend="iconv.configuration">iconv.internal_charset</link>
will be used.
</para>
<para>
The optional <parameter>charset</parameter> parameter specifies the
character set to represent the result by. If omitted,
<link linkend="iconv.configuration">iconv.internal_charset</link>
will be used.
</para>
<example>
<title><function>iconv_mime_decode_headers</function> example</title>
<programlisting role="php">
<example>
<title><function>iconv_mime_decode_headers</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$headers_string = <<<EOF
@ -101,9 +99,9 @@ $headers = iconv_mime_decode_headers($headers_string, 0, "ISO-8859-1");
print_r($headers);
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
@ -119,18 +117,18 @@ Array
)
]]>
</screen>
</example>
</screen>
</example>
<para>
See also <function>iconv_mime_decode</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</para>
</refsect1>
</refentry>
<para>
See also <function>iconv_mime_decode</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,77 +1,74 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-mime-decode">
<refnamediv>
<refname>iconv_mime_decode</refname>
<refpurpose>
Decodes a <literal>MIME</literal> header field
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_mime_decode</methodname>
<methodparam><type>string</type><parameter>encoded_header</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.8 $ -->
<refentry id="function.iconv-mime-decode">
<refnamediv>
<refname>iconv_mime_decode</refname>
<refpurpose>Decodes a <literal>MIME</literal> header field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_mime_decode</methodname>
<methodparam><type>string</type><parameter>encoded_header</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns a decoded <literal>MIME</literal> field on success,
or &false; if an error occurs during the decoding.
</para>
<para>
Returns a decoded <literal>MIME</literal> field on success,
or &false; if an error occurs during the decoding.
</para>
<para>
<parameter>mode</parameter> determines the behaviour in the event
<function>iconv_mime_decode</function> encounters a malformed
<literal>MIME</literal> header field. You can specify any combination
of the following bitmasks.
<table>
<title>Bitmasks acceptable to <function>iconv_mime_decode</function></title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>ICONV_MIME_DECODE_STRICT</entry>
<entry>
If set, the given header is decoded in full conformance with the
standards defined in <ulink url="&url.rfc;2047">RFC2047</ulink>.
This option is disabled by default because there are a lot of
broken mail user agents that don't follow the specification and don't
produce correct <literal>MIME</literal> headers.
</entry>
</row>
<row>
<entry>2</entry>
<entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
<entry>
If set, <function>iconv_mime_decode</function> attempts to continue
to process the given header even though an error occurs.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<parameter>mode</parameter> determines the behaviour in the event
<function>iconv_mime_decode</function> encounters a malformed
<literal>MIME</literal> header field. You can specify any combination
of the following bitmasks.
<table>
<title>Bitmasks acceptable to <function>iconv_mime_decode</function></title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>ICONV_MIME_DECODE_STRICT</entry>
<entry>
If set, the given header is decoded in full conformance with the
standards defined in <ulink url="&url.rfc;2047">RFC2047</ulink>.
This option is disabled by default because there are a lot of
broken mail user agents that don't follow the specification and don't
produce correct <literal>MIME</literal> headers.
</entry>
</row>
<row>
<entry>2</entry>
<entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
<entry>
If set, <function>iconv_mime_decode</function> attempts to continue
to process the given header even though an error occurs.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The optional <parameter>charset</parameter> parameter specifies the
character set to represent the result by. If omitted,
<link linkend="iconv.configuration">iconv.internal_charset</link>
will be used.
</para>
<example>
<title><function>iconv_mime_decode</function> example</title>
<programlisting role="php">
<para>
The optional <parameter>charset</parameter> parameter specifies the
character set to represent the result by. If omitted,
<link linkend="iconv.configuration">iconv.internal_charset</link>
will be used.
</para>
<para>
<example>
<title><function>iconv_mime_decode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// This yields "Subject: Prüfung Prüfung"
@ -79,17 +76,18 @@ echo iconv_mime_decode("Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=",
0, "ISO-8859-1");
?>
]]>
</programlisting>
</example>
<para>
See also <function>iconv_mime_decode_headers</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>iconv_mime_decode_headers</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,129 +1,126 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-mime-encode">
<refnamediv>
<refname>iconv_mime_encode</refname>
<refpurpose>
Composes a <literal>MIME</literal> header field
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_mime_encode</methodname>
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
<methodparam><type>string</type><parameter>field_value</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>preferences</parameter></methodparam>
</methodsynopsis>
<para>
Composes and returns a string that represents a valid <literal>MIME</literal>
header field, which looks like the following:
<screen>
<!-- $Revision: 1.11 $ -->
<refentry id="function.iconv-mime-encode">
<refnamediv>
<refname>iconv_mime_encode</refname>
<refpurpose>Composes a <literal>MIME</literal> header field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_mime_encode</methodname>
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
<methodparam><type>string</type><parameter>field_value</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>preferences</parameter></methodparam>
</methodsynopsis>
<para>
Composes and returns a string that represents a valid <literal>MIME</literal>
header field, which looks like the following:
<screen>
<![CDATA[
Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeile
]]>
</screen>
In the above example, "Subject" is the field name and the portion that
begins with "=?ISO-8859-1?..." is the field value.
</para>
<para>
You can control the behaviour of <function>iconv_mime_encode</function>
by specifying an associative array that contains configuration items
to the optional third parameter <parameter>preferences</parameter>.
The items supported by <function>iconv_mime_encode</function> are
listed below. Note that item names are treated case-sensitive.
<table>
<title>Configuration items supported by <function>iconv_mime_encode</function></title>
<tgroup cols="5">
<thead>
<row>
<entry>Item</entry>
<entry>Type</entry>
<entry>Description</entry>
<entry>Default value</entry>
<entry>Example</entry>
</row>
</thead>
<tbody>
<row>
<entry>scheme</entry>
<entry><type>boolean</type></entry>
<entry>
Specifies the method to encode a field value by. The value of
this item may be either "B" or "Q", where "B" stands for
<literal>base64</literal> encoding scheme and "Q" stands for
<literal>quoted-printable</literal> encoding scheme.
</entry>
<entry>B</entry>
<entry>B</entry>
</row>
<row>
<entry>input-charset</entry>
<entry><type>string</type></entry>
<entry>
Specifies the character set in which the first parameter
<parameter>field_name</parameter> and the second parameter
<parameter>field_value</parameter> are presented. If not given,
<function>iconv_mime_encode</function> assumes those parameters
are presented to it in the
<link linkend="iconv.configuration">iconv.internal_charset</link>
ini setting.
</entry>
<entry>
<link linkend="iconv.configuration">iconv.internal_charset</link>
</entry>
<entry>ISO-8859-1</entry>
</row>
<row>
<entry>output-charset</entry>
<entry><type>string</type></entry>
<entry>
Specifies the character set to use to compose the
<literal>MIME</literal> header. If not given, the same value as
<literal>input-charset</literal> will be used.
</entry>
<entry>
<link linkend="iconv.configuration">iconv.internal_charset</link>
</entry>
<entry>UTF-8</entry>
</row>
<row>
<entry>line-length</entry>
<entry><type>integer</type></entry>
<entry>
Specifies the maximum length of the header lines. The resulting
header is "folded" to a set of multiple lines in case
the resulting header field would be longer than the value of this
parameter, according to
<ulink url="&url.rfc;2822">RFC2822 - Internet Message Format</ulink>.
If not given, the length will be limited to 76 characters.
</entry>
<entry>76</entry>
<entry>996</entry>
</row>
<row>
<entry>line-break-chars</entry>
<entry><type>string</type></entry>
<entry>
Specifies the sequence of characters to append to each line
as an end-of-line sign when "folding" is performed on a long header
field. If not given, this defaults to "\r\n"
(<literal>CR</literal> <literal>LF</literal>). Note that
this parameter is always treated as an ASCII string regardless
of the value of <literal>input-charset</literal>.
</entry>
<entry>\r\n</entry>
<entry>\n</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<example>
<title><function>iconv_mime_encode</function> example:</title>
<programlisting role="php">
</screen>
In the above example, "Subject" is the field name and the portion that
begins with "=?ISO-8859-1?..." is the field value.
</para>
<para>
You can control the behaviour of <function>iconv_mime_encode</function>
by specifying an associative array that contains configuration items
to the optional third parameter <parameter>preferences</parameter>.
The items supported by <function>iconv_mime_encode</function> are
listed below. Note that item names are treated case-sensitive.
<table>
<title>Configuration items supported by <function>iconv_mime_encode</function></title>
<tgroup cols="5">
<thead>
<row>
<entry>Item</entry>
<entry>Type</entry>
<entry>Description</entry>
<entry>Default value</entry>
<entry>Example</entry>
</row>
</thead>
<tbody>
<row>
<entry>scheme</entry>
<entry><type>boolean</type></entry>
<entry>
Specifies the method to encode a field value by. The value of
this item may be either "B" or "Q", where "B" stands for
<literal>base64</literal> encoding scheme and "Q" stands for
<literal>quoted-printable</literal> encoding scheme.
</entry>
<entry>B</entry>
<entry>B</entry>
</row>
<row>
<entry>input-charset</entry>
<entry><type>string</type></entry>
<entry>
Specifies the character set in which the first parameter
<parameter>field_name</parameter> and the second parameter
<parameter>field_value</parameter> are presented. If not given,
<function>iconv_mime_encode</function> assumes those parameters
are presented to it in the
<link linkend="iconv.configuration">iconv.internal_charset</link>
ini setting.
</entry>
<entry>
<link linkend="iconv.configuration">iconv.internal_charset</link>
</entry>
<entry>ISO-8859-1</entry>
</row>
<row>
<entry>output-charset</entry>
<entry><type>string</type></entry>
<entry>
Specifies the character set to use to compose the
<literal>MIME</literal> header. If not given, the same value as
<literal>input-charset</literal> will be used.
</entry>
<entry>
<link linkend="iconv.configuration">iconv.internal_charset</link>
</entry>
<entry>UTF-8</entry>
</row>
<row>
<entry>line-length</entry>
<entry><type>integer</type></entry>
<entry>
Specifies the maximum length of the header lines. The resulting
header is "folded" to a set of multiple lines in case
the resulting header field would be longer than the value of this
parameter, according to
<ulink url="&url.rfc;2822">RFC2822 - Internet Message Format</ulink>.
If not given, the length will be limited to 76 characters.
</entry>
<entry>76</entry>
<entry>996</entry>
</row>
<row>
<entry>line-break-chars</entry>
<entry><type>string</type></entry>
<entry>
Specifies the sequence of characters to append to each line
as an end-of-line sign when "folding" is performed on a long header
field. If not given, this defaults to "\r\n"
(<literal>CR</literal> <literal>LF</literal>). Note that
this parameter is always treated as an ASCII string regardless
of the value of <literal>input-charset</literal>.
</entry>
<entry>\r\n</entry>
<entry>\n</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<example>
<title><function>iconv_mime_encode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$preferences = array(
@ -141,16 +138,16 @@ $preferences["scheme"] = "B";
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);
?>
]]>
</programlisting>
</example>
<para>
See also <function>imap_binary</function>,
<function>mb_encode_mimeheader</function>
and <function>imap_8bit</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>imap_binary</function>,
<function>mb_encode_mimeheader</function>
and <function>imap_8bit</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,50 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/iconv.xml, last change in rev 1.1 -->
<refentry id="function.iconv-set-encoding">
<refnamediv>
<refname>iconv_set_encoding</refname>
<refpurpose>Set current setting for character encoding conversion</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>iconv_set_encoding</methodname>
<methodparam><type>string</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
<function>iconv_set_encoding</function> changes the value of the internal
configuration variable specified by <parameter>type</parameter> to
<parameter>charset</parameter>. &return.success;
</para>
<para>
The value of <parameter>type</parameter> can be any one of those:
<simplelist>
<member>input_encoding</member>
<member>output_encoding</member>
<member>internal_encoding</member>
</simplelist>
</para>
<para>
<example>
<title><function>iconv_set_encoding</function> example:</title>
<programlisting role="php">
<!-- $Revision: 1.8 $ -->
<refentry id="function.iconv-set-encoding">
<refnamediv>
<refname>iconv_set_encoding</refname>
<refpurpose>Set current setting for character encoding conversion</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>iconv_set_encoding</methodname>
<methodparam><type>string</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
<function>iconv_set_encoding</function> changes the value of the internal
configuration variable specified by <parameter>type</parameter> to
<parameter>charset</parameter>. &return.success;
</para>
<para>
The value of <parameter>type</parameter> can be any one of those:
<simplelist>
<member>input_encoding</member>
<member>output_encoding</member>
<member>internal_encoding</member>
</simplelist>
</para>
<para>
<example>
<title><function>iconv_set_encoding</function> example:</title>
<programlisting role="php">
<![CDATA[
<?php
iconv_set_encoding("internal_encoding", "UTF-8");
iconv_set_encoding("output_encoding", "ISO-8859-1");
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>iconv_get_encoding</function> and
<function>ob_iconv_handler</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>iconv_get_encoding</function> and
<function>ob_iconv_handler</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,41 +1,38 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-strlen">
<refnamediv>
<refname>iconv_strlen</refname>
<refpurpose>
Returns the character count of string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>iconv_strlen</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the character count of <parameter>str</parameter>.
</para>
<para>
In contrast to <function>strlen</function>,
<function>iconv_strlen</function> counts the occurrences of characters
in the given byte sequence <parameter>str</parameter> on the basis of
the specified character set, the result of which is not necessarily
identical to the length of the string in byte.
</para>
<para>
If <parameter>charset</parameter> parameter is omitted,
<parameter>str</parameter> is assumed to be encoded in
<link linkend="iconv.configuration">iconv.internal_charset</link>.
</para>
<!-- $Revision: 1.6 $ -->
<refentry id="function.iconv-strlen">
<refnamediv>
<refname>iconv_strlen</refname>
<refpurpose>Returns the character count of string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>iconv_strlen</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the character count of <parameter>str</parameter>.
</para>
<para>
In contrast to <function>strlen</function>,
<function>iconv_strlen</function> counts the occurrences of characters
in the given byte sequence <parameter>str</parameter> on the basis of
the specified character set, the result of which is not necessarily
identical to the length of the string in byte.
</para>
<para>
If <parameter>charset</parameter> parameter is omitted,
<parameter>str</parameter> is assumed to be encoded in
<link linkend="iconv.configuration">iconv.internal_charset</link>.
</para>
<para>
See also <function>strlen</function> and <function>mb_strlen</function>.
</para>
</refsect1>
</refentry>
<para>
See also <function>strlen</function> and <function>mb_strlen</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,63 +1,60 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-strpos">
<refnamediv>
<refname>iconv_strpos</refname>
<refpurpose>
Finds position of first occurrence of a needle within a haystack
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>iconv_strpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the numeric position of the first occurrence of
<parameter>needle</parameter> in <parameter>haystack</parameter>.
</para>
<para>
The optional <parameter>offset</parameter> parameter specifies
the position from which the search should be performed.
</para>
<para>
If <parameter>needle</parameter> is not found,
<function>iconv_strpos</function> will return &false;.
</para>
<!-- $Revision: 1.8 $ -->
<refentry id="function.iconv-strpos">
<refnamediv>
<refname>iconv_strpos</refname>
<refpurpose>Finds position of first occurrence of a needle within a haystack</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>iconv_strpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the numeric position of the first occurrence of
<parameter>needle</parameter> in <parameter>haystack</parameter>.
</para>
<para>
The optional <parameter>offset</parameter> parameter specifies
the position from which the search should be performed.
</para>
<para>
If <parameter>needle</parameter> is not found,
<function>iconv_strpos</function> will return &false;.
</para>
&return.falseproblem;
&return.falseproblem;
<para>
If <parameter>haystack</parameter> or <parameter>needle</parameter> is
not a string, it is converted to a string and applied as the ordinal
value of a character.
</para>
<para>
If <parameter>haystack</parameter> or <parameter>needle</parameter> is
not a string, it is converted to a string and applied as the ordinal
value of a character.
</para>
<para>
In contrast to <function>strpos</function>, the return value of
<function>iconv_strpos</function> is the number of characters that
appear before the needle, rather than the offset in bytes to the
position where the needle has been found. The characters are counted
on the basis of the specified character set <parameter>charset</parameter>.
</para>
<para>
In contrast to <function>strpos</function>, the return value of
<function>iconv_strpos</function> is the number of characters that
appear before the needle, rather than the offset in bytes to the
position where the needle has been found. The characters are counted
on the basis of the specified character set <parameter>charset</parameter>.
</para>
<para>
If <parameter>charset</parameter> parameter is omitted,
<parameter>string</parameter> are assumed to be encoded in
<link linkend="iconv.configuration">iconv.internal_charset</link>.
</para>
<para>
If <parameter>charset</parameter> parameter is omitted,
<parameter>string</parameter> are assumed to be encoded in
<link linkend="iconv.configuration">iconv.internal_charset</link>.
</para>
<para>
See also <function>strpos</function>, <function>iconv_strrpos</function>
and <function>mb_strpos</function>.
</para>
</refsect1>
</refentry>
<para>
See also <function>strpos</function>, <function>iconv_strrpos</function>
and <function>mb_strpos</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,53 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-strrpos">
<refnamediv>
<refname>iconv_strrpos</refname>
<refpurpose>
Finds the last occurrence of a needle within a haystack
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>iconv_strrpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the numeric position of the last occurrence of
<parameter>needle</parameter> in <parameter>haystack</parameter>.
</para>
<!-- $Revision: 1.7 $ -->
<refentry id="function.iconv-strrpos">
<refnamediv>
<refname>iconv_strrpos</refname>
<refpurpose>Finds the last occurrence of a needle within a haystack</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>iconv_strrpos</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the numeric position of the last occurrence of
<parameter>needle</parameter> in <parameter>haystack</parameter>.
</para>
<para>
If <parameter>needle</parameter> is not found,
<function>iconv_strrpos</function> will return &false;.
</para>
<para>
If <parameter>needle</parameter> is not found,
<function>iconv_strrpos</function> will return &false;.
</para>
&return.falseproblem;
&return.falseproblem;
<para>
If <parameter>haystack</parameter> or <parameter>needle</parameter> is
not a string, it is converted to a string and applied as the ordinal
value of a character.
</para>
<para>
If <parameter>haystack</parameter> or <parameter>needle</parameter> is
not a string, it is converted to a string and applied as the ordinal
value of a character.
</para>
<para>
In contrast to <function>strpos</function>, the return value of
<function>iconv_strrpos</function> is the number of characters that
appear before the needle, rather than the offset in bytes to the
position where the needle has been found. The characters are counted
on the basis of the specified character set <parameter>charset</parameter>.
</para>
<para>
See also <function>strrpos</function>, <function>iconv_strpos</function>
and <function>mb_strrpos</function>.
</para>
</refsect1>
</refentry>
<para>
In contrast to <function>strpos</function>, the return value of
<function>iconv_strrpos</function> is the number of characters that
appear before the needle, rather than the offset in bytes to the
position where the needle has been found. The characters are counted
on the basis of the specified character set <parameter>charset</parameter>.
</para>
<para>
See also <function>strrpos</function>, <function>iconv_strpos</function>
and <function>mb_strrpos</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,79 +1,76 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-substr">
<refnamediv>
<refname>iconv_substr</refname>
<refpurpose>
Cut out part of a string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_substr</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.5 $ -->
<refentry id="function.iconv-substr">
<refnamediv>
<refname>iconv_substr</refname>
<refpurpose>Cut out part of a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_substr</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the portion of <parameter>str</parameter> specified by
the <parameter>start</parameter> and <parameter>length</parameter>
parameters.
</para>
<para>
Returns the portion of <parameter>str</parameter> specified by
the <parameter>start</parameter> and <parameter>length</parameter>
parameters.
</para>
<para>
If <parameter>start</parameter> is non-negative,
<function>iconv_substr</function> cuts the portion out of
<parameter>str</parameter> beginning at <parameter>start</parameter>'th
character, counting from zero.
</para>
<para>
If <parameter>start</parameter> is non-negative,
<function>iconv_substr</function> cuts the portion out of
<parameter>str</parameter> beginning at <parameter>start</parameter>'th
character, counting from zero.
</para>
<para>
If <parameter>start</parameter> is negative,
<function>iconv_substr</function> cuts out the portion beginning
at the position, <parameter>start</parameter> characters
away from the end of <parameter>str</parameter>.
</para>
<para>
If <parameter>start</parameter> is negative,
<function>iconv_substr</function> cuts out the portion beginning
at the position, <parameter>start</parameter> characters
away from the end of <parameter>str</parameter>.
</para>
<para>
If <parameter>length</parameter> is given and is positive, the return
value will contain at most <parameter>length</parameter> characters
of the portion that begins at <parameter>start</parameter>
(depending on the length of <parameter>string</parameter>).
If <parameter>str</parameter> is shorter than <parameter>start</parameter>
characters long, &false; will be returned.
</para>
<para>
If <parameter>length</parameter> is given and is positive, the return
value will contain at most <parameter>length</parameter> characters
of the portion that begins at <parameter>start</parameter>
(depending on the length of <parameter>string</parameter>).
If <parameter>str</parameter> is shorter than <parameter>start</parameter>
characters long, &false; will be returned.
</para>
<para>
If negative <parameter>length</parameter> is passed,
<function>iconv_substr</function> cuts the portion out of
<parameter>str</parameter> from the <parameter>start</parameter>'th
character up to the character that is
<parameter>length</parameter> characters away from the end of the string.
In case <parameter>start</parameter> is also negative, the start position
is calculated beforehand according to the rule explained above.
</para>
<para>
If negative <parameter>length</parameter> is passed,
<function>iconv_substr</function> cuts the portion out of
<parameter>str</parameter> from the <parameter>start</parameter>'th
character up to the character that is
<parameter>length</parameter> characters away from the end of the string.
In case <parameter>start</parameter> is also negative, the start position
is calculated beforehand according to the rule explained above.
</para>
<para>
Note that <parameter>offset</parameter> and <parameter>length</parameter>
parameters are always deemed to represent offsets that are
calculated on the basis of the character set determined by
<parameter>charset</parameter>, whilst the counterpart
<function>substr</function> always takes these for byte offsets.
If <parameter>charset</parameter> is not given, the character set
is determined by the <link linkend="iconv.configuration">iconv.internal_encoding</link>
ini setting.
</para>
<para>
Note that <parameter>offset</parameter> and <parameter>length</parameter>
parameters are always deemed to represent offsets that are
calculated on the basis of the character set determined by
<parameter>charset</parameter>, whilst the counterpart
<function>substr</function> always takes these for byte offsets.
If <parameter>charset</parameter> is not given, the character set
is determined by the <link linkend="iconv.configuration">iconv.internal_encoding</link>
ini setting.
</para>
<para>
See also <function>substr</function>, <function>mb_substr</function>
and <function>mb_strcut</function>.
</para>
</refsect1>
</refentry>
<para>
See also <function>substr</function>, <function>mb_substr</function>
and <function>mb_strcut</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,48 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/iconv.xml, last change in rev 1.1 -->
<refentry id="function.iconv">
<refnamediv>
<refname>iconv</refname>
<refpurpose>Convert string to requested character encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv</methodname>
<methodparam><type>string</type><parameter>in_charset</parameter></methodparam>
<methodparam><type>string</type><parameter>out_charset</parameter></methodparam>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
Performs a character set conversion on the string
<parameter>str</parameter> from <parameter>in_charset</parameter>
to <parameter>out_charset</parameter>. Returns the converted
string or &false; on failure.
</para>
<para>If you append the string <literal>//TRANSLIT</literal> to
<parameter>out_charset</parameter> transliteration is activated. This
means that when a character can't be represented in the target charset,
it can be approximated through one or several similarly looking
characters. If you append the string <literal>//IGNORE</literal>,
characters that cannot be represented in the target charset are silently
discarded. Otherwise, <parameter>str</parameter> is cut from the first
illegal character.
</para>
<para>
<example>
<title><function>iconv</function> example:</title>
<programlisting role="php">
<!-- $Revision: 1.11 $ -->
<refentry id="function.iconv">
<refnamediv>
<refname>iconv</refname>
<refpurpose>Convert string to requested character encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv</methodname>
<methodparam><type>string</type><parameter>in_charset</parameter></methodparam>
<methodparam><type>string</type><parameter>out_charset</parameter></methodparam>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
Performs a character set conversion on the string
<parameter>str</parameter> from <parameter>in_charset</parameter>
to <parameter>out_charset</parameter>. Returns the converted
string or &false; on failure.
</para>
<para>If you append the string <literal>//TRANSLIT</literal> to
<parameter>out_charset</parameter> transliteration is activated. This
means that when a character can't be represented in the target charset,
it can be approximated through one or several similarly looking
characters. If you append the string <literal>//IGNORE</literal>,
characters that cannot be represented in the target charset are silently
discarded. Otherwise, <parameter>str</parameter> is cut from the first
illegal character.
</para>
<para>
<example>
<title><function>iconv</function> example:</title>
<programlisting role="php">
<![CDATA[
<?php
echo iconv("ISO-8859-1", "UTF-8", "This is a test.");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,48 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/iconv.xml, last change in rev 1.1 -->
<refentry id="function.ob-iconv-handler">
<refnamediv>
<refname>ob_iconv_handler</refname>
<refpurpose>Convert character encoding as output buffer handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ob_iconv_handler</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>int</type><parameter>status</parameter></methodparam>
</methodsynopsis>
<para>
It converts the string encoded in
<parameter>internal_encoding</parameter> to
<parameter>output_encoding</parameter>.
</para>
<para>
<parameter>internal_encoding</parameter> and
<parameter>output_encoding</parameter> should be defined
by <function>iconv_set_encoding</function> or in the
configuration file &php.ini;.
</para>
<para>
<example>
<title><function>ob_iconv_handler</function> example:</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry id="function.ob-iconv-handler">
<refnamediv>
<refname>ob_iconv_handler</refname>
<refpurpose>Convert character encoding as output buffer handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ob_iconv_handler</methodname>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
<methodparam><type>int</type><parameter>status</parameter></methodparam>
</methodsynopsis>
<para>
It converts the string encoded in
<parameter>internal_encoding</parameter> to
<parameter>output_encoding</parameter>.
</para>
<para>
<parameter>internal_encoding</parameter> and
<parameter>output_encoding</parameter> should be defined
by <function>iconv_set_encoding</function> or in the
configuration file &php.ini;.
</para>
<para>
<example>
<title><function>ob_iconv_handler</function> example:</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start("ob_iconv_handler"); // start output buffering
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>iconv_get_encoding</function>,
<function>iconv_set_encoding</function> and
<link linkend="ref.outcontrol">output-control functions</link>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>iconv_get_encoding</function>,
<function>iconv_set_encoding</function> and
<link linkend="ref.outcontrol">output-control functions</link>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: