stristr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stristr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stristr</refname>
  <refpurpose>Case-insensitive <function>strstr</function></refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>stristr</methodname>
   <methodparam><type>string</type><parameter>haystack</parameter></methodparam>
   <methodparam><type>string</type><parameter>needle</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>before_needle</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns all of <parameter>haystack</parameter> starting from and including the first
   occurrence of <parameter>needle</parameter> to the end.
  </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>before_needle</parameter></term>
     <listitem>
      <para>
       If &true;, <function>stristr</function>
       returns the part of the <parameter>haystack</parameter> before the
       first occurrence of the <parameter>needle</parameter> (excluding needle).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   <parameter>needle</parameter> and <parameter>haystack</parameter>
   are examined in a case-insensitive manner.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the matched substring. If <parameter>needle</parameter> is not
   found, returns &false;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <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>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>stristr</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
  $email = 'USER@EXAMPLE.com';
  echo stristr($email, 'e'); // outputs ER@EXAMPLE.com
  echo stristr($email, 'e', true); // outputs US
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Testing if a string is found or not</title>
    <programlisting role="php">
<![CDATA[
<?php
  $string = 'Hello World!';
  if(stristr($string, 'earth') === FALSE) {
    echo '"earth" not found in string';
  }
// outputs: "earth" not found in string
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Using a non "string" needle</title>
    <programlisting role="php">
<![CDATA[
<?php
  $string = 'APPLE';
  echo stristr($string, 97); // 97 = lowercase a
// outputs: APPLE
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>strstr</function></member>
    <member><function>strrchr</function></member>
    <member><function>stripos</function></member>
    <member><function>strpbrk</function></member>
    <member><function>preg_match</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
-->