strcspn.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 89990d6588947665d4e9c029ee83696f1a9d3d11 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu,jdkfx -->
<refentry xml:id="function.strcspn" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strcspn</refname>
  <refpurpose>マスクにマッチしない最初のセグメントの長さを返す</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>strcspn</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>strcspn(substr($string, $offset, $length),
   $characters)</literal> をコールするのと同じ動きになります。
   (詳細は <xref linkend="function.substr"/> を参照ください)。
  </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>strcspn</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>strcspn</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> の文字をまったく<emphasis>含まない</emphasis>
   最初のセグメントの長さを返します。
  </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.4.0</entry>
      <entry>
       <simpara>
        PHP 8.4.0 より前のバージョンでは、 <parameter>characters</parameter> が空の文字列の場合、
        <parameter>string</parameter> 内の最初の null バイトで探索が誤って停止してしまうことがありました。
       </simpara>
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="strcspn.example">
   <title><function>strcspn</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
$a = strcspn('banana', 'a');
$b = strcspn('banana', 'abcd');
$c = strcspn('banana', 'z');
$d = strcspn('abcdhelloabcd', 'a', -9);
$e = strcspn('abcdhelloabcd', 'a', -9, -5);

var_dump($a);
var_dump($b);
var_dump($c);
var_dump($d);
var_dump($e);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
int(1)
int(0)
int(6)
int(5)
int(4)
]]>
   </screen>
  </example>
 </refsect1>

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

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