strcspn

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

strcspn — Возвращает длину участка в начале строки, не соответствующего маске

Описание

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

Возвращает длину участка в начале строки string, который не содержит ни одного символа из строки characters.

Если параметры offset и length не указаны, то все содержимое string будет исследовано. Если же эти параметры указаны, то эффект будет таким же, как при вызове strcspn(substr($string, $offset, $length), $characters) (смотрите substr для дополнительной информации).

Список параметров

string

Строка для исследования.

characters

Строка, содержащая каждый из запрещённых символов.

offset

Позиция в строке string, с которой начинается поиск.

Если offset указан и не является отрицательным значением, тогда strcspn() начнёт обследование строки string с позиции, указанной в offset. Например: в строке 'abcdef', символ в позиции 0 это 'a', символ в позиции 2 это 'c', и так далее.

Если offset указан, но является отрицательным числом, то strspn() начнёт обследование строки string с позиции, указанной в параметре offset, начиная с конца строки string.

length

Длина фрагмента из string для обследования.

Если параметр length указан и не является отрицательным значением, тогда будет обследовано length символов из string, отсчитывая от стартовой позиции.

Если length передан и значение отрицательное, то будут проверяться символы, начиная со стартовой позиции и до length с конца string.

Возвращаемые значения

Возвращает длину начального фрагмента строки string, которая состоит полностью из символов, не включённых в параметр characters.

Замечание:
Когда параметр offset указан, возвращаемая длина определяется, начиная с этой позиции, а не с начала строки string.

Список изменений

Версия	Описание
8.0.0	`length` теперь допускает значение null.

Примеры

Пример #1 Пример использования 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);
?>

Результат выполнения приведённого примера:

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

Примечания

Замечание: Эта функция безопасна для обработки данных в двоичной форме.

Смотрите также

strspn() - Возвращает длину участка в начале строки, полностью соответствующего маске

add a note

User Contributed Notes 5 notes

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

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

legacyprog at routinz dot net ¶

13 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 ¶

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

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

add a note