mb-strstr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: takagi Status: ready -->
<refentry xml:id="function.mb-strstr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mb_strstr</refname>
  <refpurpose>文字列の中で、指定した文字列が最初に現れる位置を見つける</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>mb_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>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>mb_strstr</function> は、
   <parameter>haystack</parameter> の中で最初に
   <parameter>needle</parameter> が現れる場所を探し、
   <parameter>haystack</parameter> の部分文字列を返します。
   <parameter>needle</parameter> が見つからなかった場合は
   &false; を返します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>haystack</parameter></term>
     <listitem>
      <para>
       <parameter>needle</parameter> が最初に現れる位置を見つける文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>needle</parameter></term>
     <listitem>
      <para>
       <parameter>haystack</parameter> の中で探す文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>before_needle</parameter></term>
     <listitem>
      <para>
       この関数が <parameter>haystack</parameter> のどの部分を返すのかを指定します。
       &true; の場合は、<parameter>haystack</parameter> の先頭から
       <parameter>needle</parameter> が最初に現れる位置までを返します (needle を含めません)。
       &false; の場合は、<parameter>needle</parameter> が最初に現れる位置から
       <parameter>haystack</parameter> の最後までを返します (needle を含めます)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       使用する文字エンコーディング名。
       省略した場合は内部文字エンコーディングが用いられます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>haystack</parameter> の部分文字列を返します。
   <parameter>needle</parameter> が見つからない場合は &false; を返します。
  </para>
 </refsect1>

 <!-- Use when ERRORS exist
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   When does this function throw E_* level errors, or exceptions?
  </para>
 </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;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>mb_strstr</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->

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