strspn

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

strspn — Trouve la longueur du segment initial d'une chaîne contenant tous les caractères d'un masque donné

Description

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

Trouve la longueur du segment initial de string qui contient uniquement les caractères depuis le masque characters.

Si les paramètres offset et length sont omis, alors toutes les chaînes string seront analysées. S'ils sont fournis, alors les effets seront identiques à appeler strspn(substr($string, $offset, $length), $characters) (voir substr pour plus d'informations).

Le code suivant :

<?php
$var = strspn("42 est la réponse, mais quelle est la question.", "1234567890");
?>

assigne 2 à la variable $var, car la chaîne "42" est le segment initial du paramètre string dont les caractères sont contenus dans "1234567890".

Liste de paramètres

string

La chaîne à analyser.

characters

La liste des caractères autorisés.

offset

La position dans la chaîne string à partir de laquelle nous devons chercher.

Si offset est fourni et n'est pas négatif, alors strspn() commencera à analyser la chaîne string à la position offset. Par exemple, dans la chaîne 'abcdef', le caractère à la position 0 est 'a', le caractère à la position 2 est 'c', et ainsi de suite.

Si offset est fourni et est négatif, alors strspn() commencera à analyser la chaîne string à la position offset depuis la fin de la chaîne string.

length

La longueur de la chaîne à analyser.

Si length est fourni et n'est pas négatif, alors string sera examiné sur length caractères après la position de départ.

Si length est fourni et est négatif, alors string sera examiné sur length caractères depuis la fin de la chaîne string.

Valeurs de retour

Retourne la taille du segment initial de la chaîne string qui est entièrement constitué de caractères contenus dans characters.

Note:
Lorsque le paramètre offset est défini, la longueur retournée est comptée à partir de cette position, et non depuis le début du paramètre string.

Historique

Version	Description
8.0.0	`length` est désormais nullable.

Exemples

Exemple #1 Exemple avec strspn()

<?php
// Le sujet ne commence pas par un des caractères depuis le masque
var_dump(strspn("foo", "o"));

// Examine 2 caractères depuis le début du sujet, à la position 1
var_dump(strspn("foo", "o", 1, 2));

// Examine un caractère depuis le début du sujet, à la position 1
var_dump(strspn("foo", "o", 1, 1));
?>

L'exemple ci-dessus va afficher :

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

Notes

Note: Cette fonction gère les chaînes binaires.

Voir aussi

strcspn() - Trouve un segment de chaîne ne contenant pas certains caractères

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

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 ¶

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 ¶

5 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