PHP 7.0.6 Released

strcspn

(PHP 4, PHP 5, PHP 7)

strcspnマスクにマッチしない最初のセグメントの長さを返す

説明

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

subject において mask の文字がどれも含まれていない最初のセグメントの長さを返します。

startlength を省略した場合は、subject の全体を調べます。 これらのパラメータを指定した場合は、 strcspn(substr($subject, $start, $length), $mask) のようにするのと同じ動きになります (詳細は substr を参照ください)。

パラメータ

subject

調べたい文字列。

mask

許可しない文字をすべて含む文字列。

start

subject の中で調べ始める位置。

start に非負の値を指定した場合は、 strcspn() は、 subjectstart 番目の文字から調べ始めます。 たとえば 'abcdef' という文字列があったとすると、 0 番目の文字が 'a' で 2 番目の文字は 'c' のようになります。

start に負の値を指定した場合は、 strcspn() は、 subject の後ろから start 番目の文字から調べ始めます。

length

subject の中での調べるセグメントの長さ。

length に非負の値を指定した場合は、 subject の開始位置から length 文字ぶんだけ調べます。

length に負の値を指定した場合は、 subject の開始位置から調べ始めて、 subject の末尾から length 文字目のところまで調べます。

返り値

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 4 notes

up
3
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
2
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
2
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
2
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";
}
?>
To Top