php-doc-en/reference/iconv/functions/iconv-strrpos.xml
2011-08-19 10:03:54 +00:00

114 lines
3.3 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.iconv-strrpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>iconv_strrpos</refname>
<refpurpose>Finds the last occurrence of a needle within a haystack</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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><initializer>ini_get("iconv.internal_encoding")</initializer></methodparam>
</methodsynopsis>
<para>
Finds the last occurrence of a <parameter>needle</parameter>
within a <parameter>haystack</parameter>.
</para>
<para>
In contrast to <function>strrpos</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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>haystack</parameter></term>
<listitem>
<para>
The entire string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>needle</parameter></term>
<listitem>
<para>
The searched substring.
</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>
</listitem>
</varlistentry>
</variablelist>
</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>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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>
&return.falseproblem;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>strrpos</function></member>
<member><function>iconv_strpos</function></member>
<member><function>mb_strrpos</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
-->