<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.strspn" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>strspn</refname>

<refpurpose>

Encuentra la longitud del segmento inicial de un string que contiene

todos los caracteres de una máscara dada

</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>

Encuentra la longitud del segmento inicial de <parameter>string</parameter>

que contiene <emphasis>únicamente</emphasis> los caracteres

desde la máscara <parameter>characters</parameter>.

</para>

<para>

Si los parámetros <parameter>offset</parameter> y <parameter>length</parameter>

son omitidos, entonces todo el string <parameter>string</parameter> será

analizado. Si son proporcionados, entonces los efectos serán idénticos a llamar

<literal>strspn(substr($string, $offset, $length), $characters)</literal>

(ver <xref linkend="function.substr" /> para más información).

</para>

<para>

El código siguiente:

<informalexample>

<programlisting role="php">

</programlisting>

</informalexample>

asigna <literal>2</literal> a la variable <varname>$var</varname>,

ya que el string "42" es el segmento inicial del parámetro

<parameter>string</parameter> cuyos caracteres están contenidos en

"1234567890".

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

El string a analizar.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>characters</parameter></term>

<listitem>

<para>

La lista de caracteres autorizados.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>offset</parameter></term>

<listitem>

<para>

La posición en el string <parameter>string</parameter> a

partir de la cual se debe buscar.

</para>

<para>

Si <parameter>offset</parameter> es proporcionado y no es negativo,

entonces <function>strspn</function> comenzará a analizar el string

<parameter>string</parameter> en la posición <parameter>offset</parameter>.

Por ejemplo, en el string '<literal>abcdef</literal>', el carácter

en la posición <literal>0</literal> es '<literal>a</literal>', el carácter

en la posición <literal>2</literal> es '<literal>c</literal>', y así

sucesivamente.

</para>

<para>

Si <parameter>offset</parameter> es proporcionado y es negativo,

entonces <function>strspn</function> comenzará a analizar el string

<parameter>string</parameter> en la posición <parameter>offset</parameter>

desde el final del string <parameter>string</parameter>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>length</parameter></term>

<listitem>

<para>

La longitud del string a analizar.

</para>

<para>

Si <parameter>length</parameter> es proporcionado y no es negativo,

entonces <parameter>string</parameter> será examinado sobre

<parameter>length</parameter> caracteres después de la posición de inicio.

</para>

<para>

Si <parameter>length</parameter> es proporcionado y es negativo,

entonces <parameter>string</parameter> será examinado sobre

<parameter>length</parameter> caracteres desde el final

del string <parameter>string</parameter>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retorna el tamaño del segmento inicial del string

<parameter>string</parameter> que está enteramente

constituido de caracteres contenidos en <parameter>characters</parameter>.

</para>

<note>

<para>

Cuando el parámetro <parameter>offset</parameter> está definido, la longitud

retornada es contada a partir de esta posición, y no desde el inicio

del parámetro <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> es ahora nullable.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <function>strspn</function></title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</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>