strspn

(PHP 4, PHP 5, PHP 7, PHP 8)

strspn — Encuentra la longitud del segmento inicial de un string que contiene todos los caracteres de una máscara dada

Descripción

strspn(
    string $string,
    string $characters,
    int $offset = 0,
    ?int $length = null
): int

Encuentra la longitud del segmento inicial de string que contiene únicamente los caracteres desde la máscara characters.

Si los parámetros offset y length son omitidos, entonces todo el string string será analizado. Si son proporcionados, entonces los efectos serán idénticos a llamar strspn(substr($string, $offset, $length), $characters) (ver substr para más información).

El código siguiente:

<?php
$var = strspn("42 es la respuesta, pero ¿cuál es la pregunta?", "1234567890");
?>

asigna 2 a la variable $var, ya que el string "42" es el segmento inicial del parámetro string cuyos caracteres están contenidos en "1234567890".

Parámetros

string

El string a analizar.

characters

La lista de caracteres autorizados.

offset

La posición en el string string a partir de la cual se debe buscar.

Si offset es proporcionado y no es negativo, entonces strspn() comenzará a analizar el string string en la posición offset. Por ejemplo, en el string 'abcdef', el carácter en la posición 0 es 'a', el carácter en la posición 2 es 'c', y así sucesivamente.

Si offset es proporcionado y es negativo, entonces strspn() comenzará a analizar el string string en la posición offset desde el final del string string.

length

La longitud del string a analizar.

Si length es proporcionado y no es negativo, entonces string será examinado sobre length caracteres después de la posición de inicio.

Si length es proporcionado y es negativo, entonces string será examinado sobre length caracteres desde el final del string string.

Valores devueltos

Retorna el tamaño del segmento inicial del string string que está enteramente constituido de caracteres contenidos en characters.

Nota:
Cuando el parámetro offset está definido, la longitud retornada es contada a partir de esta posición, y no desde el inicio del parámetro string.

Historial de cambios

Versión	Descripción
8.0.0	`length` es ahora nullable.

Ejemplos

Ejemplo #1 Ejemplo con strspn()

<?php
// El sujeto no comienza con uno de los caracteres desde la máscara
var_dump(strspn("foo", "o"));

// Examina 2 caracteres desde el inicio del sujeto, en la posición 1
var_dump(strspn("foo", "o", 1, 2));

// Examina un carácter desde el inicio del sujeto, en la posición 1
var_dump(strspn("foo", "o", 1, 1));
?>

El resultado del ejemplo sería:

int(0)
int(2)
int(1)

Notas

Nota: Esta función es segura binariamente.

Ver también

strcspn() - Encuentra un segmento de string que no contiene ciertos caracteres

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 8 notes

down

barry dot balkowski at gmail dot com ¶

16 years ago

It took me some time to understand the way this function works…
I’ve compiled my own explanation with my own words that is more understandable for me personally than the official one or those that can be found in different tutorials on the web.
Perhaps, it will save someone several minutes…

<?php 
strspn(string $haystack, string $char_list [, int $start [, int $length]])
?>

The way it works:
 -   searches for a segment of $haystack that consists entirely from supplied through the second argument chars 
 -   $haystack must start from one of the chars supplied through $char_list, otherwise the function will find nothing
 -   as soon as the function encounters a char that was not mentioned in $chars it understands that the segment is over and stops (it doesn’t search for the second, third and so on segments)
 -   finally, it measures the segment’s length and return it (i.e. length)

In other words it finds a span (only the first one) in the string that consists entirely form chars supplied in $chars_list and returns its length

down

AT-HE (at_he.hotmail) ¶

14 years ago

you can use this function with strlen to check illegal characters, string lenght must be the same than strspn (characters from my string contained in another)

<?php

$digits='0123456789';

if (strlen($phone) != strspn($phone,$digits))
 echo "illegal characters";

?>

down

B Crawford ¶

17 years ago

This function is significantly faster for checking illegal characters than the equivalent preg_match() method.

down

mrsohailkhan at gmail dot com ¶

14 years ago

very dificult to get from the definition directly, while i search for that,i came to know that



strspn() will tell you the length of a string consisting entirely of the set of characters in accept set. That is, it starts walking down str until it finds a character that is not in the set (that is, a character that is not to be accepted), and returns the length of the string so far. 



and 



strcspn() works much the same way, except that it walks down str until it finds a character in the reject set (that is, a character that is to be rejected.) It then returns the length of the string so far.



<?php

$acceptSet = "aeiou";

$rejectSet  = "y";



$str1 ="a banana";

$str2 ="the bolivian navy on manuvers in the south pacific";



echo $n = strspn($str1,$acceptSet);// $n == 1, just "a"



echo $n = strcspn($str2,$rejectSet);// n = 16, "the bolivian nav"

?>



hope this example will help in understanding the concept of strspn() and strcspn().

down

Dmitry Mazur ¶

16 years ago

The second parameter is a set of allowed characters.
strspn will return an zero-based index of a first non-allowed character.

down

bob at example dot com ¶

13 years ago

Quick way to check if a string consists entirely of characters within the mask is to compare strspn with strlen eg:



<?php

$path = $_SERVER['PATH_INFO'];

if (strspn($path,'/') == strlen($path)) {

    //PATH_INFO is empty

}

?>

down

lincoln dot mahmud at gmail dot com ¶

4 years ago

Get Group match letter

<?php 

$s= 'aaabbbcceeffaaeeeaaabbzmmm';

function groupby( $s ){
    static $a = [];
    static $i = 0;
    
    $o = strspn( $s, $s[$i], $i);
    $a[ $i ] = [  $s[$i] => $o ];
    $i += $o;
    
    if( $i < strlen($s) ) {
        groupby($s);
    }

    return $a;
}

print_r(groupby($s));

?>

down

-1

nino dot skopac at gmail dot com ¶

7 years ago

strspon and preg_match seem to be equally fast for validating numbers:

<?php

$testValInvalid = 'foobar123^^';
$testValValid = '12346';
$allowedChars = '1234567890';

$t1 = microtime(true);
for ($i = 0; $i < 1000000; $i++) {
    assert(strspn($testValInvalid, $allowedChars) != strlen($testValInvalid));
    assert(strspn($testValValid, $allowedChars) == strlen($testValValid));
}
print 'Time taken for strspon: ' . (microtime(true) - $t1);
print PHP_EOL;

$t1 = microtime(true);
for ($i = 0; $i < 1000000; $i++) {
    assert(preg_match('/^[0-9]+$/', $testValInvalid) === 0);
    assert(preg_match('/^[0-9]+$/', $testValValid));
}

print 'Time taken for preg_match: ' . (microtime(true) - $t1);
print PHP_EOL;

/**
nino-mcb:hosp_web ninoskopac$ php test.php
Time taken for strspon: 3.24165391922
Time taken for preg_match: 3.1820080280304
nino-mcb:hosp_web ninoskopac$ php test.php
Time taken for strspon: 3.1806418895721
Time taken for preg_match: 3.2244551181793
 */
?>

＋add a note