strcspn

(PHP 4, PHP 5, PHP 7)

strcspn — Ermittelt die Anzahl der nicht übereinstimmenden Zeichen

Beschreibung

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

Gibt die Länge von subject zurück, bis zu der kein Zeichen aus mask vorkommt.

Wenn die Parameter start und length ausgelassen werden, dann wird das gesamte subject untersucht. Werden sie angegeben, dann ist es gleichwertig zum Aufruf von strcspn(substr($subject, $start, $length), $mask) (siehe substr für weitere Informationen).

Parameter-Liste

subject

Die zu untersuchende Zeichenkette.

mask

Die Zeichenkette, die jedes nicht erlaubte Zeichen enthält.

start

Die Position in subject, an der die Suche beginnt.

Wird start angegeben und es nicht negativ ist, dann beginnt strcspn() das subject an der start Position zu untersuchen. Beispielsweise ist in der Zeichenkette 'abcdef' das Zeichen an Position 0 ein 'a', das Zeichen an Position 2 ein 'c', usw.

Wird start angegeben und es negativ ist, dann beginnt strcspn() das subject an der start Position vom Ende von subject zu untersuchen.

length

Die Länge des Segments von subject, das untersucht werden soll.

Wird length angegeben und es nicht negativ ist, dann wird subject für length Zeichen nach der Anfangsposition untersucht.

Wird length angegeben und es negativ ist, dann wird subject von der Anfangsposition bis zu length Zeichen vom Ende von subject untersucht.

Rückgabewerte

Gibt die Länge des Anfangssegments von subject zurück, das ausschließlich aus Zeichen besteht, die nicht in mask vorkommen.

Hinweis:
Wird der start Parameter angegeben, dann zählt die zurückgegebene Länge von dieser Position, nicht vom Anfang von subject.

Beispiele

Beispiel #1 strcspn() Beispiel


<?php
$a = strcspn('abcd',  'apple');
$b = strcspn('abcd',  'banana');
$c = strcspn('hello', 'l');
$d = strcspn('hello', 'world');
$e = strcspn('abcdhelloabcd', 'abcd', -9);
$f = strcspn('abcdhelloabcd', 'abcd', -9, -5);

var_dump($a);
var_dump($b);
var_dump($c);
var_dump($d);
var_dump($e);
var_dump($f);
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

int(0)
int(0)
int(2)
int(2)
int(5)
int(4)

Anmerkungen

Hinweis: Diese Funktion ist binary safe.

Siehe auch

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

add a note

User Contributed Notes 5 notes

down

maskedcoder at hotmail dot com ¶

14 years ago


useful for finding beginning of quotes and/or tags in a variable containing html.  
    $pos = strcspn($data, '<"\''); 
will find the first occurance of either the beginning of a tag, or a double- or single-quoted string.

down

AT-HE (at_he AT hotmai1 DOT com) ¶

14 years ago


this function can be used like strspn(), except while that can be used to compare a string with an allowed pattern, this one can be use to compare a string with a FORBIDDEN pattern

so, to know if any forbidden character has a position inside our string, we can use (not tested with backslashes)...

<?php
// LARGE VERSION
$forbidden="\"\\?*:/@|<>";
if (strlen($filename) != strcspn($filename,$forbidden)) {
    echo "you cant create a file with that name!";
}

// SHORT VERSION
if (strlen($filename) - strcspn($filename,"\"\\?*:/@|<>")) {
    echo "i told you, you cant create that file";
}
?>

down

legacyprog at routinz dot net ¶

9 years ago


When you use the third parameter remember that the function will return the number of characters it bypassed, which will *not* be the position in your source string.  It's a simple fix to just add your third parameter value to the function result to get the position in the first string where the scan stopped, but I didn't think of it at first.

down

nospam at nospam dot com ¶

4 years ago


It might not be clear from the example, that

strcspn('abcdhelloabcd', 'abcd', -9, -5) == 4

because it's only evaluating 'hell' which doesn't contain any mask, so returns strlen('hell').

down

Anonymous ¶

10 years ago


strcspn() can also be thought of as analogous to the following regular expression:
<?php
// where ... represents the mask of characters
preg_match('/[^ ...]/', substr($subject, $start, $length) );
?>
By this analogy, strcspn() can be used in place of some regular expressions to match a pattern without the overhead of a regex engine -- for example, ways to verify if an input string represents a binary value:
<?php
preg_match('/^[01]+$/i', $subject);
// or...
!preg_match('/[^01]/i', $subject);

// ...or using strcspn()
!strcspn($subject, '01');
?>

add a note