strcspn

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

strcspn — Ermittelt die Anzahl der nicht übereinstimmenden Zeichen

Beschreibung

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

Gibt die Länge des Anfangssegments von string zurück, bis zu der kein Zeichen aus characters vorkommt.

Wenn die Parameter offset und length weggelassen werden, dann wird string komplett untersucht. Werden sie angegeben, dann ist es gleichwertig zum Aufruf von strcspn(substr($string, $offset, $length), $characters) (für weitere Informationen siehe substr).

Parameter-Liste

string

Die zu untersuchende Zeichenkette.

characters

Die Zeichenkette, die alle nicht erlaubten Zeichen enthält.

offset

Die Position in string, an der die Suche beginnt.

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

Wird offset angegeben und ist negativ, dann beginnt strcspn() string an der Position offset vom Ende von string aus betrachtet zu untersuchen.

length

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

Wird length angegeben und ist nicht negativ, dann werden bis zu length Zeichen von string nach der Anfangsposition untersucht.

Wird length angegeben und ist negativ, dann wird string von der Anfangsposition bis zu length Zeichen vom Ende von string aus betrachtet untersucht.

Rückgabewerte

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

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

Changelog

Version	Beschreibung
8.4.0	Wenn vor PHP 8.4.0 `characters` eine leere Zeichenkette war, wurde die Suche fälschlicherweise beim ersten Null-Byte in `string` beendet.
8.0.0	`length` ist jetzt nullable (akzeptiert den `null`-Wert).

Beispiele

Beispiel #1 strcspn()-Beispiel

<?php
$a = strcspn('banana', 'a');
$b = strcspn('banana', 'abcd');
$c = strcspn('banana', 'z');
$d = strcspn('abcdhelloabcd', 'a', -9);
$e = strcspn('abcdhelloabcd', 'a', -9, -5);

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

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

int(1)
int(0)
int(6)
int(5)
int(4)

Anmerkungen

Hinweis: Diese Funktion ist binärsicher.

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

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 5 notes

down

AT-HE (at_he AT hotmai1 DOT com) ¶

18 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

maskedcoder at hotmail dot com ¶

19 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

legacyprog at routinz dot net ¶

14 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

Anonymous ¶

15 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');
?>

down

nospam at nospam dot com ¶

8 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').

＋add a note