strspn

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

strspn — Encontra o comprimento do segmento inicial de uma string composta totalmente de caracteres contidos em uma máscara informada

Descrição

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

Encontra o comprimento do segmento inicial da string que contenha somente caracteres contidos em characters.

Se offset e length forem omitidos, então toda a string será examinada. Se forem incluídos, o efeito será o mesmo que chamar strspn(substr($string, $offset, $length), $characters) (consulte substr para mais informações).

A linha de código:

<?php
$var = strspn("42 is the answer to the 128th question.", "1234567890");
?>

atribuirá 2 para $var, porque a string "42" é o segmento inicial de string que consiste somente de caracteres contidos em "1234567890".

Parâmetros

string

A primeira a ser examinada.

characters

A lista de caracteres permitidos.

offset

A posição na string para iniciar a pesquisa.

Se offset for informado e não negativo, a função strspn() começará a examinar a string na posição offset. Por exemplo, na string 'abcdef', o caractere na posição 0 é 'a', na posição 2 é 'c', e assim por diante.

Se offset for informado e negativo, a função strspn() começará a examinar a string na posição offset a partir do final da string.

length

O tamanho do segmento da string a ser examinado.

Se length for informado e não negativo, a string será examinada pelo número de caracteres em length a partir da posição inicial.

Se length for informado e negativo, a string será examinada a partir da posição inicial até o número de caracteres informado em length contados a partir do final da string.

Valor Retornado

Retorna o comprimento do segmento inicial de string que consistir inteiramente dos caracteres definidos em characters.

Nota:
Quando o parâmetro offset estiver definido, o comprimento retornado é contado iniciando-se desta posição, não do início da string.

Registro de Alterações

Versão	Descrição
8.0.0	`length` agora pode ser nulo.

Exemplos

Exemplo #1 strspn() example

<?php
// string não começa com nenhum dos caracteres da máscara
var_dump(strspn("foo", "o"));

// examina dois caracteres da string iniciando na posição 1
var_dump(strspn("foo", "o", 1, 2));

// examina um caractere da string iniciando na posição 1
var_dump(strspn("foo", "o", 1, 1));
?>

O exemplo acima produzirá:

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

Notas

Nota: Esta função é compatível com dados binários.

Veja Também

strcspn() - Encontra o tamanho do segmento inicial que não corresponde à máscara

add a note

User Contributed Notes 9 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) ¶

13 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 ¶

13 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 ¶

15 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 ¶

12 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

nino dot skopac at gmail dot com ¶

6 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
 */
?>

down

-7

ayaou dot mohammed at gmail dot com ¶

4 years ago


This function doesn't  work with non ASCII characters

Exemple:

<?php

$subject = "Comment ça va ma chérie";
$mask = "éèçà";

echo strspn($subject,$mask); // Echo 0

?>

See, we expected  1 but 0 was the correct result

add a note