strripos.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.strripos" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strripos</refname>
  <refpurpose>Find the position of the last occurrence of a case-insensitive substring in a string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>strripos</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><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Find the numeric position of the last occurrence of
   <parameter>needle</parameter> in the <parameter>haystack</parameter> string.
  </para>
  <para>
   Unlike the <function>strrpos</function>, <function>strripos</function> is
   case-insensitive.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       The string to search in.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       The string to search for.
      </para>
      &strings.parameter.needle.non-string;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       If zero or positive, the search is performed left to right skipping the
       first <parameter>offset</parameter> bytes of the
       <parameter>haystack</parameter>.
      </para>
      <para>
       If negative, the search is performed right to left skipping the
       last <parameter>offset</parameter> bytes of the
       <parameter>haystack</parameter> and searching for the first occurrence
       of <parameter>needle</parameter>.
       <note>
        <para>
         This is effectively looking for the last occurrence of
         <parameter>needle</parameter> before the last
         <parameter>offset</parameter> bytes.
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the position where the <parameter>needle</parameter> exists relative to the beginning of
   the <parameter>haystack</parameter> string (independent of search direction
   or <parameter>offset</parameter>).
   <note>
    <simpara>
     String positions start at 0, and not 1.
    </simpara>
   </note>
  </para>
  <para>
   Returns &false; if the <parameter>needle</parameter> was not found.
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <itemizedlist>
   <listitem>
    <simpara>
     If <parameter>offset</parameter> is greater than the length of
     <parameter>haystack</parameter>, a
     <classname>ValueError</classname> will be thrown.
    </simpara>
   </listitem>
  </itemizedlist>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &strings.changelog.ascii-case-folding;
     &strings.changelog.needle-empty;
     <row>
      <entry>8.0.0</entry>
      <entry>
       Passing an &integer; as <parameter>needle</parameter> is no longer supported.
      </entry>
     </row>
     <row>
      <entry>7.3.0</entry>
      <entry>
       Passing an &integer; as <parameter>needle</parameter> has been deprecated.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A simple <function>strripos</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$haystack = 'ababcd';
$needle   = 'aB';

$pos      = strripos($haystack, $needle);

if ($pos === false) {
    echo "Sorry, we did not find `$needle` in `$haystack`";
} else {
    echo "Congratulations!\n";
    echo "We found the last `$needle` in `$haystack` at position `$pos`";
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Congratulations!
We found the last `aB` in `ababcd` at position `2`
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>strpos</function></member>
    <member><function>stripos</function></member>
    <member><function>strrpos</function></member>
    <member><function>strrchr</function></member>
    <member><function>stristr</function></member>
    <member><function>substr</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
-->