mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
14af302c9c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334762 c90b9560-bf6c-de11-be94-00142212c4b1
138 lines
4.7 KiB
XML
138 lines
4.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.iconv-substr" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>iconv_substr</refname>
|
|
<refpurpose>Cut out part of a string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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><initializer>iconv_strlen($str, $charset)</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>charset</parameter><initializer>ini_get("iconv.internal_encoding")</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Cuts a portion of <parameter>str</parameter> specified by the
|
|
<parameter>offset</parameter> and <parameter>length</parameter> parameters.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>str</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The original string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>offset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>offset</parameter> is non-negative,
|
|
<function>iconv_substr</function> cuts the portion out of
|
|
<parameter>str</parameter> beginning at <parameter>offset</parameter>'th
|
|
character, counting from zero.
|
|
</para>
|
|
<para>
|
|
If <parameter>offset</parameter> is negative,
|
|
<function>iconv_substr</function> cuts out the portion beginning
|
|
at the position, <parameter>offset</parameter> characters
|
|
away from the end of <parameter>str</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<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>offset</parameter>
|
|
(depending on the length of <parameter>string</parameter>).
|
|
</para>
|
|
<para>
|
|
If negative <parameter>length</parameter> is passed,
|
|
<function>iconv_substr</function> cuts the portion out of
|
|
<parameter>str</parameter> from the <parameter>offset</parameter>'th
|
|
character up to the character that is
|
|
<parameter>length</parameter> characters away from the end of the string.
|
|
In case <parameter>offset</parameter> is also negative, the start position
|
|
is calculated beforehand according to the rule explained above.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>charset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>charset</parameter> parameter is omitted,
|
|
<parameter>string</parameter> are assumed to be encoded in
|
|
<link linkend="iconv.configuration">iconv.internal_encoding</link>.
|
|
</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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the portion of <parameter>str</parameter> specified by the
|
|
<parameter>offset</parameter> and <parameter>length</parameter> parameters.
|
|
</para>
|
|
<para>
|
|
If <parameter>str</parameter> is shorter than <parameter>offset</parameter>
|
|
characters long, &false; will be returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>substr</function></member>
|
|
<member><function>mb_substr</function></member>
|
|
<member><function>mb_strcut</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
|
|
-->
|