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
strspn
(PHP 4, PHP 5)
strspn — Trouve la longueur du segment initial d'une chaîne contenant tous les caractères d'un masque donné
Description
$subject
, string $mask
[, int $start
[, int $length
]] )
Trouve la longueur du segment initial de subject
qui contient uniquement les caractères
depuis le masque mask.
Si les paramètres start et length
sont omis, alors toutes les chaînes subject seront
analysées. S'ils sont fournis, alors les effets seront identiques à appeler
strspn(substr($subject, $start, $length), $mask)
(voir substr pour plus d'informations).
Le code suivant :
<?php
$var = strspn("42 est la réponse, mais quelle est la question.", "1234567890");
?>
subject dont les caractères sont contenus dans
"1234567890".
Liste de paramètres
-
subject -
La chaîne à analyser.
-
mask -
La liste des caractères autorisés.
-
start -
La position dans la chaîne
subjectà partir de laquelle nous devons chercher.Si
startest fourni et n'est pas négatif, alors strspn() commencera à analyser la chaînesubjectà la positionstart. 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
startest fourni et est négatif, alors strspn() commencera à analyser la chaînesubjectà la positionstartdepuis la fin de la chaînesubject. -
length -
La longueur de la chaîne à analyser.
Si
lengthest fourni et n'est pas négatif, alorssubjectsera examiné surlengthcaractères après la position de départ.Si
lengthest fourni et est négatif, alorssubjectsera examiné surlengthcaractères depuis la fin de la chaînesubject.
Valeurs de retour
Retourne la taille du segment initial de la chaîne
subject qui est entièrement
constitué de caractères contenus dans mask.
Historique
| Version | Description |
|---|---|
| 4.3.0 |
Ajout des paramètres start et length
|
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.
This function is significantly faster for checking illegal characters than the equivalent preg_match() method.
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
}
?>
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().
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";
?>
The second parameter is a set of allowed characters.
strspn will return an zero-based index of a first non-allowed character.
