International PHP Conference Munich 2021

strcspn

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

strcspnTrouve un segment de chaîne ne contenant pas certains caractères

Description

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

Retourne la taille du premier segment de string qui ne contient aucun des caractères de characters.

Si offset et length sont omis, alors la totalité de string sera examinée. S'ils sont inclus, alors l'effet sera identique à appeler strcspn(substr($subject, $start, $length), $mask) (voir substr pour plus d'informations).

Liste de paramètres

string

La chaîne à examiner.

characters

La chaîne contenant tous les caractères désactivés.

offset

La position dans string à partir de laquelle on commence à chercher.

Si offset est fourni et n'est pas négatif, alors strcspn() va commencer à examiner string à la offset ème position. 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 offset est fourni et est négatif, alors strspn() va commencer à examiner string à la offset ème position depuis la fin de string.

length

La longueur du segment de string à examiner.

Si length est fourni et n'est pas négatif, alors string sera examiné depuis length caractères après la position de départ.

Si length est fourni et est négatif, alors string sera examiné depuis la position de départ jusqu'à length caractères depuis la fin de string.

Valeurs de retour

Retourne la longueur du segment initial de string qui contient seulement des caractères qui ne sont pas dans characters.

Note:

Lorsque le paramètre offset est définie, la longueur retournée est comptée depuis cette position, et non depuis le début de string.

Historique

Version Description
8.0.0 length est désormais nullable.

Exemples

Exemple #1 Exemple avec strcspn()

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

L'exemple ci-dessus va afficher :

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

Notes

Note: Cette fonction gère les chaînes binaires.

Voir aussi

  • strspn() - Trouve la longueur du segment initial d'une chaîne contenant tous les caractères d'un masque donné

add a note add a note

User Contributed Notes 5 notes

up
7
maskedcoder at hotmail dot com
15 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.
up
6
AT-HE (at_he AT hotmai1 DOT com)
15 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";
}
?>
up
2
legacyprog at routinz dot net
10 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.
up
0
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').
up
0
Anonymous
11 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');
?>
To Top