Files
archived-doc-pt-br/reference/mbstring/functions/mb-strpos.xml
Leonardo Lara Rodrigues 452d861bfb sync with en rev
2025-11-04 18:29:39 -03:00

149 lines
4.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 95d05546430b9e5db225dd42a0d285b870f0da42 Maintainer: leonardolara Status: ready --><!-- CREDITS: fernandowobeto, leonardolara -->
<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_strpos</refname>
<refpurpose>Encontra a posição da primeira ocorrência de uma string em outra</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>mb_strpos</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>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Encontra a posição da primeira ocorrência de <parameter>needle</parameter> na string de <parameter>haystack</parameter>.
</para>
<para>
Realiza uma operação
<function>strpos</function> segura para multibyte com base no número de
caracteres. A posição do primeiro caractere é 0, a posição do segundo
caractere é 1, e assim por diante.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>haystack</parameter></term>
<listitem>
<para>
A string da qual será obtida a posição da primeira ocorrência
de <parameter>needle</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>needle</parameter></term>
<listitem>
<para>
A string a ser encontrada em <parameter>haystack</parameter>. Em contraste
com <function>strpos</function>, valores numéricos não são aplicados
como o valor ordinal de um caractere.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
A posição de início da pesquisa. Se não for especificada, 0 é usado.
Uma posição negativa conta a partir do final da string no sentido contrário.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
&mbstring.encoding.parameter;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna a posição numérica da
primeira ocorrência de <parameter>needle</parameter> na
<type>string</type> <parameter>haystack</parameter>. Se
<parameter>needle</parameter> não for encontrada, retorna &false;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
Se <parameter>offset</parameter> for maior que o comprimento de
<parameter>haystack</parameter>, um
<classname>ValueError</classname> será lançado.
</simpara>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.needle-empty;
&mbstring.changelog.encoding-nullable;
<row>
<entry>7.1.0</entry>
<entry>
Adicionado suporte para posições negativas no parâmetro <parameter>offset</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_internal_encoding</function></member>
<member><function>strpos</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
-->