strspn.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 422bb032237525aaf50e6a43f33362a2c610a1d7 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<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> 中全部字符<emphasis>仅</emphasis>存在于 <parameter>characters</parameter> 中的第一组连续字符(子字符串)的长度。
  </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> 将被指派为 2，因为 '42' 是 <parameter>string</parameter> 中第一段全部字符都存在于 '1234567890' 的连续字符。
  </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>c</literal>'，等等。
      </para>
      <para>
       如果 <parameter>offset</parameter> 被设置并且为负数，<function>strspn</function> 将从 <parameter>string</parameter> 的尾部倒数第 <parameter>offset</parameter> 个位置开始检查 <parameter>string</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>length</parameter> 个位置，对 <parameter>string</parameter> 进行检查。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回完全由 <parameter>characters</parameter> 中的字符组成的 <parameter>string</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> 现在允许为 null。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>strspn</function> 示例</title>
    <programlisting role="php">
<![CDATA[
<?php
echo strspn("foo", "o", 1, 2); // 打印: 2
?>
]]>
    </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
-->