archived-doc-ja/reference/strings/functions/strstr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<refentry xml:id="function.strstr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strstr</refname>
  <refpurpose>文字列が最初に現れる位置を見つける</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>
   <parameter>haystack</parameter> の中で <parameter>needle</parameter>
   が最初に現れる場所を含めてそこから文字列の終わりまでを返します。
  </para>
  <note>
   <para>
    この関数は大文字小文字を区別することに注意してください。
    大文字小文字を区別しない検索を行う場合は、<function>stristr</function>
    を使用してください。
   </para>
  </note>
  <note>
   <para>
    もし特定の <parameter>haystack</parameter> に
    <parameter>needle</parameter> があるかどうかを調べるだけの場合、
    より高速でメモリ消費も少ない <function>strpos</function>
    を代わりに使用してください。
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       入力文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       検索する文字列。
      </para>
      &strings.parameter.needle.non-string;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>before_needle</parameter></term>
     <listitem>
      <para>
       &true; にすると、<function>strstr</function>
       の戻り値は、<parameter>haystack</parameter> の中で最初に
       <parameter>needle</parameter> があらわれる箇所より前の部分となります (needle は含めません)。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   部分文字列を返します。
   <parameter>needle</parameter> が見つからない場合は &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.needle-empty;
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>needle</parameter> に数値を渡すことはサポートされなくなりました。
       </entry>
      </row>
      <row>
       <entry>7.3.0</entry>
       <entry>
        <parameter>needle</parameter> に数値を渡すことは非推奨になりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>strstr</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$email  = 'name@example.com';
$domain = strstr($email, '@');
echo $domain, PHP_EOL; // @example.com と表示します

$user = strstr($email, '@', true);
echo $user, PHP_EOL; // name と表示します
?>
]]>
    </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
-->