PHP 7.1.0 Release Candidate 3 Released

strcspn

(PHP 4, PHP 5, PHP 7)

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

Описание

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

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

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

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

subject

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

mask

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

start

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

Если start указан и не является отрицательным значением, тогда strcspn() начнет обследование строки subject с позиции, указанной в start. 'a', символ в позиции 2 это 'c', и так далее.

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

length

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

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

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

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

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

Замечание:

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

Примеры

Пример #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 add a note

User Contributed Notes 5 notes

up
5
maskedcoder at hotmail dot com
10 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
4
AT-HE (at_he AT hotmai1 DOT com)
10 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
3
legacyprog at routinz dot net
5 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
1
Anonymous
6 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');
?>
up
1
nospam at nospam dot com
29 days 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').
To Top