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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 422bb032237525aaf50e6a43f33362a2c610a1d7 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.strspn" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strspn</refname>
  <refpurpose>
   指定したマスク内に含まれる文字からなる文字列の最初のセグメントの長さを探す
  </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>strspn</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>string</type><parameter>characters</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>string</parameter> の中で、
   <parameter>characters</parameter> 内の文字<emphasis>だけ</emphasis>を含む最初の部分の長さを返します。
  </para>
  <para>
   <parameter>offset</parameter> と <parameter>length</parameter>
   を省略した場合は、<parameter>string</parameter> 全体を調べます。
   指定した場合は、<literal>strspn(substr($string, $offset, $length),
   $characters)</literal> をコールするのと同じ動きになります。
   (詳細は <xref linkend="function.substr"/> を参照ください)
  </para>
  <para>
   たとえば、
   <informalexample>
    <programlisting role="php">
<![CDATA[
<?php
$var = strspn("42 is the answer to the 128th question.", "1234567890");
?>
]]>
    </programlisting>
   </informalexample>
   このコードは、<varname>$var</varname> に <literal>2</literal> を代入します。これは、
   <parameter>string</parameter> の中で "1234567890" 内の文字だけで構成される
   最初の部分が "42" であるためです。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       調べたい文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>characters</parameter></term>
     <listitem>
      <para>
       許可する文字の一覧。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       <parameter>string</parameter> の中で調べ始める位置。
      </para>
      <para>
       <parameter>offset</parameter> に非負の値を指定すると、
       <function>strspn</function> は
       <parameter>string</parameter> の
       <parameter>offset</parameter> 番目の位置から調査を始めます。
       たとえば、文字列 '<literal>abcdef</literal>' において
       <literal>0</literal> 番目の位置にある文字は '<literal>a</literal>'
       で <literal>2</literal> 番目の位置にある文字は
       '<literal>c</literal>' のようになります。
      </para>
      <para>
       <parameter>offset</parameter> に負の値を指定すると、
       <function>strspn</function> は
       <parameter>string</parameter> の最後から
       <parameter>offset</parameter> 番目の位置から調査を始めます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       <parameter>string</parameter> 内で調べる部分の長さ。
      </para>
      <para>
       <parameter>length</parameter> に非負の値を指定すると、
       <parameter>string</parameter> の開始位置から
       <parameter>length</parameter> 文字分の範囲を調査します。
      </para>
      <para>
        <parameter>length</parameter> に負の値を指定すると、
        <parameter>string</parameter> の調査範囲は
        開始位置から始まって <parameter>string</parameter>
        の最後から <parameter>length</parameter> だけさかのぼったところまでとなります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>string</parameter> の中で、全て
   <parameter>characters</parameter> の中の文字からなる最初のセグメントの長さを返します。
  </para>
  <note>
   <para>
    <parameter>offset</parameter> パラメータを設定した場合は、返される長さはその位置からのものとなります。
    <parameter>string</parameter> の先頭からの長さではありません。
   </para>
  </note>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>strspn</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// subjectの最初の文字がmaskのどの文字とも一致しません
var_dump(strspn("foo", "o"));

// subject のオフセット 1 から 2 文字を調べます
var_dump(strspn("foo", "o", 1, 2));

// subject のオフセット 1 から 1 文字を調べます
var_dump(strspn("foo", "o", 1, 1));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(0)
int(2)
int(1)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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

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