ConFoo: Call for paper is now Open

strspn

(PHP 4, PHP 5)

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

Beschreibung

int strspn ( string $subject , string $mask [, int $start [, int $length ]] )

Ermittelt die Länge des initialen Abschnitts von subject der ausschließlich Zeichen aus mask enthält.

Wenn start und length ausgelassen werden, werden alle Zeichen von subject untersucht. Wenn sie enthalten sind, ist das Ergebnis das Gleiche wie der Aufruf strspn(substr($subject, $start, $length), $mask) (siehe substr für mehr Informationen).

Die Zeile

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

Parameter-Liste

subject

Die zu untersuchende Zeichenkette.

mask

Die Menge der erlaubten Zeichen.

start

Die Position in subject an der die Suche startet.

Wurde start übergeben und ist nicht-negativ, wird strspn() beginnen subject an der startn Position zu untersuchen. Zum Beispiel in der Zeichenkette 'abcdef', das Zeichen an Position 0 ist 'a', das Zeichen an Position 2 ist 'c' und so weiter.

Wurdestart übergeben und ist negativ, wird strspn() beginnen subject an der startn Position vom Ende von subject zu untersuchen.

length

Die zu untersuchende Länge des Abschnitts von subject.

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

Wurde start übergeben und ist negativ, wird subject von der Startposition bis zu length Zeichen vom Ende von subject untersucht.

Rückgabewerte

Gibt die Länge des Abschnittes am Anfang von subject zurück, der vollständig aus in mask angegebenen Zeichen besteht.

Changelog

Version Beschreibung
4.3.0 Die Parameter start und length wurden hinzugefügt.

Beispiele

Beispiel #1 strspn()-Beispiel

<?php
// subject beginnt nicht mit einem der Zeichen aus mask
var_dump(strspn("foo""o"));

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

// Untersuche ein Zeichen aus subject 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 6 notes

up
3
B Crawford
6 years ago
This function is significantly faster for checking illegal characters than the equivalent preg_match() method.
up
2
barry dot balkowski at gmail dot com
6 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
1
AT-HE (at_he.hotmail)
3 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
1
Dmitry Mazur
5 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
mrsohailkhan at gmail dot com
3 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
bob at example dot com
2 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
}
?>
To Top