sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

- Add documentation for iconv_substr()

Browse source 
- More "See Also" entries


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147249 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Moriyoshi Koizumi 2003-12-23 12:21:27 +00:00
parent fd70bee799
commit 7aff13742c
6 changed files with 72 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
reference/iconv/functions/iconv-mime-decode-headers.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.iconv-mime-decode-headers">
<refnamediv>
<refname>iconv_mime_decode_headers</refname>
@ -122,7 +122,9 @@ Array
<para>
See also <function>iconv_mime_decode</function>,
<function>imap_base64_decode</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</para>
</refsect1>

6
reference/iconv/functions/iconv-mime-decode.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-mime-decode">
<refnamediv>
@ -81,7 +81,9 @@ echo iconv_mime_decode("Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=",
</example>
<para>
See also <function>iconv_mime_decode_headers</function>,
<function>imap_base64_decode</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</para>
</refsect1>

3
reference/iconv/functions/iconv-mime-encode.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-mime-encode">
<refnamediv>
@ -144,6 +144,7 @@ echo iconv_mime_encode("Subject", "Pr&uuml;fung Pr&uuml;fung", $preferences);
<para>
See also <function>imap_base64_encode</function>,
<function>mb_encode_mimeheader</function>
and <function>imap_8bit</function>.
</para>
</refsect1>

4
reference/iconv/functions/iconv-strpos.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-strpos">
<refnamediv>
@ -53,7 +53,7 @@
</para>
<para>
See also <function>strpos</function>, <function>iconv_strrpos</function>,
See also <function>strpos</function>, <function>iconv_strrpos</function>
and <function>mb_strpos</function>.
</para>
</refsect1>

6
reference/iconv/functions/iconv-strrpos.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-strrpos">
<refnamediv>
@ -42,6 +42,10 @@
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>

58
reference/iconv/functions/iconv-substr.xml
View file

@ -1,11 +1,11 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-substr">
<refnamediv>
<refname>iconv_substr</refname>
<refpurpose>
Returns specified part of a string
Cut out part of a string
</refpurpose>
</refnamediv>
<refsect1>
@ -18,8 +18,60 @@
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<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 negative,
<function>iconv_substr</function> cuts out the portion beginning
at the position that is the <parameter>start</parameter>'th character
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 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 <parameter>length</parameter> character
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_charset</link>
ini setting.
</para>
<para>
See also <function>substr</function>, <function>mb_substr</function>
and <function>mb_strcut</function>.
</para>
</refsect1>
</refentry>