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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 422bb032237525aaf50e6a43f33362a2c610a1d7 Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 1.0 Reviewer: samesch -->
<refentry xml:id="function.strspn" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strspn</refname>
  <refpurpose>
   Ermittelt die Länge des initialen Abschnitts einer Zeichenkette, der
   ausschließlich aus Zeichen besteht, die in einer übergebenen Maske
   enthalten sind
  </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>
   Ermittelt die Länge des initialen Abschnitts von
   <parameter>string</parameter>, der<emphasis>ausschließlich</emphasis>
   Zeichen aus <parameter>characters</parameter> enthält.
  </para>
  <para>
   Wenn <parameter>offset</parameter> und <parameter>length</parameter>
   weggelassen werden, werden alle Zeichen von <parameter>string</parameter>
   untersucht. Wenn sie enthalten sind, ist das Ergebnis das Gleiche, wie der
   Aufruf <literal>strspn(substr($string, $offset, $length),
   $characters)</literal> (siehe <xref linkend="function.substr"/> für weitere
   Informationen).
  </para>
  <para>
   Die Zeile
   <informalexample>
    <programlisting role="php">
<![CDATA[
<?php
$var = strspn("42 ist die Antwort auf die 128. Frage.", "1234567890");
?>
]]>
    </programlisting>
   </informalexample>
   ordnet <literal>2</literal> der Variable <varname>$var</varname> zu, da die
   Zeichenkette "42" der initiale Abschnitt von <parameter>string</parameter>
   ist, der ausschließlich aus Zeichen besteht, die in "1234567890" enthalten
   sind.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Die zu untersuchende Zeichenkette.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>characters</parameter></term>
     <listitem>
      <para>
       Die Menge der erlaubten Zeichen.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Die Position in <parameter>string</parameter>, an der die Suche startet.
      </para>
      <para>
       Wurde <parameter>offset</parameter> übergeben und ist nicht negativ,
       beginnt <function>strspn</function> die Untersuchung von
       <parameter>string</parameter> an der Position
       <parameter>offset</parameter>. Zum Beispiel ist in der Zeichenkette
       '<literal>abcdef</literal>' das Zeichen an Position
       <literal>0</literal> '<literal>a</literal>', das Zeichen an Position
       <literal>2</literal> ist '<literal>c</literal>' usw.
      </para>
      <para>
       Wurde <parameter>offset</parameter> übergeben und ist negativ, beginnt
       <function>strspn</function> die Untersuchung von
       <parameter>string</parameter> an der Position
       <parameter>offset</parameter> vom Ende von
       <parameter>string</parameter> aus betrachtet.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Die zu untersuchende Länge des Abschnitts von
       <parameter>string</parameter>.
      </para>
      <para>
       Wurde <parameter>length</parameter> übergeben und ist nicht-negativ,
       werden <parameter>length</parameter> Zeichen
       von <parameter>string</parameter> nach der Startposition untersucht.
      </para>
      <para>
       Wurde <parameter>length</parameter> übergeben und ist negativ,
       wird <parameter>string</parameter> von der Startposition bis zu
       <parameter>length</parameter> Zeichen vom Ende von
       <parameter>string</parameter> aus betrachtet untersucht.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt die Länge des initialen Abschnitts von <parameter>string</parameter>
   zurück, der vollständig aus Zeichen besteht, die in
   <parameter>characters</parameter> angegeben sind.
  </para>
  <note>
   <para>
    Wird der Parameter <parameter>offset</parameter> angegeben, dann zählt die
    zurückgegebene Länge von dieser Position aus, nicht vom Anfang von
    <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> ist jetzt nullable (akzeptiert den
       &null;-Wert).
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>strspn</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
// Die Zeichenkette beginnt nicht mit einem der Zeichen aus der Maske
var_dump(strspn("foo", "o"));

// Untersuche zwei Zeichen aus der Zeichenkette beginnend bei Offset 1
var_dump(strspn("foo", "o", 1, 2));

// Untersuche ein Zeichen aus der Zeichenkette beginnend bei Offset 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
-->