strspn.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 422bb032237525aaf50e6a43f33362a2c610a1d7 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<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 — ответ на 128 вопрос.", "1234567890");

?>
]]>
    </programlisting>
   </informalexample>
   присвоит <literal>2</literal> переменной <varname>$var</varname>,
   поскольку «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>subject</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> символов с конца
       <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Длина фрагмента строки <parameter>string</parameter> для проверки.
      </para>
      <para>
       Если параметр <parameter>length</parameter> указали и значение аргумента неотрицательно,
       функция проверит <parameter>length</parameter> символов
       с начала строки <parameter>string</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>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> теперь принимает значение null.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>strspn</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Проверяемая строка не начинается ни с одного сивола маски
var_dump(strspn("foo", "o"));

// Проверить два символа входной строки начиная со смещения 1
var_dump(strspn("foo", "o", 1, 2));

// Проверить один символ входной строки начиная со смещения 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
-->