archived-doc-pt-br/reference/strings/functions/strstr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xml:id="function.strstr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strstr</refname>
  <refpurpose>Encontra a primeira ocorrência de uma string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>strstr</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>
   Retorna parte da string <parameter>haystack</parameter> iniciando a partir da primeira
   ocorrência de <parameter>needle</parameter> (inclusive) até o final de
   <parameter>haystack</parameter>.
  </para>
  <note>
   <para>
    Este função é sensível a maiúsculas/minúsculas. Para pesquisas insensíveis a maiúsculas/minúsculas, use
    <function>stristr</function>.
   </para>
  </note>
  <note>
   <para>
    Se for necessário apenas determinar se um <parameter>needle</parameter> em particular
    ocorre dentro de <parameter>haystack</parameter>, a função mais rápida e que
    consome menos memória, <function>str_contains</function>, deve ser usada em seu lugar.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       A string de entrada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       A string sendo procurada.
      </para>
      &strings.parameter.needle.non-string;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>before_needle</parameter></term>
     <listitem>
      <para>
       Se for igual a &true;, <function>strstr</function> retorna
       a parte de <parameter>haystack</parameter> antes da primeira
       ocorrência de <parameter>needle</parameter> (excluindo este último).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna a parte da string ou &false; se <parameter>needle</parameter>
   não for encontrada.
  </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.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>
        Passar um &integer; em <parameter>needle</parameter> não é mais suportado.
       </entry>
      </row>
      <row>
       <entry>7.3.0</entry>
       <entry>
        Passar um &integer; em <parameter>needle</parameter> foi descontinuado.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemplo de <function>strstr</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$email  = 'nome@exemplo.com';
$domain = strstr($email, '@');
echo $domain, PHP_EOL; // mostra @exemplo.com

$user = strstr($email, '@', true);
echo $user, PHP_EOL; // mostra nome
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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