PHP 8.1.0 RC 4 available for testing

strspn

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

strspn Ermittelt die Länge des initialen Abschnitts einer Zeichenkette, der ausschließlich aus Zeichen besteht, die in einer übergebenen Maske enthalten sind

Beschreibung

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

Ermittelt die Länge des initialen Abschnitts von string, derausschließlich Zeichen aus characters enthält.

Wenn offset und length weggelassen werden, werden alle Zeichen von string untersucht. Wenn sie enthalten sind, ist das Ergebnis das Gleiche, wie der Aufruf strspn(substr($string, $offset, $length), $characters) (siehe substr für weitere Informationen).

Die Zeile

<?php
$var 
strspn("42 ist die Antwort auf die 128. Frage.""1234567890");
?>
ordnet 2 der Variable $var zu, da die Zeichenkette "42" der initiale Abschnitt von string ist, der ausschließlich aus Zeichen besteht, die in "1234567890" enthalten sind.

Parameter-Liste

string

Die zu untersuchende Zeichenkette.

characters

Die Menge der erlaubten Zeichen.

offset

Die Position in string, an der die Suche startet.

Wurde offset übergeben und ist nicht negativ, beginnt strspn() die Untersuchung von string an der Position offset. Zum Beispiel ist in der Zeichenkette 'abcdef' das Zeichen an Position 0 'a', das Zeichen an Position 2 ist 'c' usw.

Wurde offset übergeben und ist negativ, beginnt strspn() die Untersuchung von string an der Position offset vom Ende von string aus betrachtet.

length

Die zu untersuchende Länge des Abschnitts von string.

Wurde length übergeben und ist nicht-negativ, werden length Zeichen von string nach der Startposition untersucht.

Wurde length übergeben und ist negativ, wird string von der Startposition bis zu length Zeichen vom Ende von string aus betrachtet untersucht.

Rückgabewerte

Gibt die Länge des initialen Abschnitts von string zurück, der vollständig aus Zeichen besteht, die in characters angegeben sind.

Hinweis:

Wird der Parameter offset angegeben, dann zählt die zurückgegebene Länge von dieser Position aus, nicht vom Anfang von string.

Changelog

Version Beschreibung
8.0.0 length ist jetzt nullable (akzeptiert den null-Wert).

Beispiele

Beispiel #1 strspn()-Beispiel

<?php
// Die Zeichenkette beginnt nicht mit einem der Zeichen aus der Maske
var_dump(strspn("foo""o"));

// Untersuche zwei Zeichen aus der Zeichenkette beginnend bei Offset 1
var_dump(strspn("foo""o"12));

// Untersuche ein Zeichen aus der Zeichenkette beginnend bei Offset 1
var_dump(strspn("foo""o"11));
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

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

Anmerkungen

Hinweis: Diese Funktion ist binary-safe.

Siehe auch

  • strcspn() - Ermittelt die Anzahl der nicht übereinstimmenden Zeichen

add a note add a note

User Contributed Notes 9 notes

up
20
barry dot balkowski at gmail dot com
13 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
up
18
AT-HE (at_he.hotmail)
10 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";

?>
up
8
B Crawford
14 years ago
This function is significantly faster for checking illegal characters than the equivalent preg_match() method.
up
5
mrsohailkhan at gmail dot com
10 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().
up
1
nino dot skopac at gmail dot com
3 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
*/
?>
up
3
bob at example dot com
9 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
}
?>
up
2
Dmitry Mazur
12 years ago
The second parameter is a set of allowed characters.
strspn will return an zero-based index of a first non-allowed character.
up
1
lincoln dot mahmud at gmail dot com
1 year 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));

?>
up
-3
ayaou dot mohammed at gmail dot com
1 year 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
To Top