PHP 5.4.31 Released

strspn

(PHP 4, PHP 5)

strspn 指定したマスク内に含まれる文字からなる文字列の最初のセグメントの長さを探す

説明

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

subject の中で、 mask 内の文字だけを含む最初の部分の長さを返します。

startlength を省略した場合は、subject 全体を調べます。 指定した場合は、strspn(substr($subject, $start, $length), $mask) (詳細は substr を参照ください) をコールするのと同じ働きをします。

たとえば、

<?php
$var 
strspn("42 is the answer to the 128th question.""1234567890");
?>
このコードは、$var2 を代入します。これは、 subject の中で "1234567890" 内の文字だけで構成される 最初の部分が "42" であるためです。

パラメータ

subject

調べたい文字列。

mask

許可する文字の一覧。

start

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

start に非負の値を指定すると、 strspn()subjectstart 番目の位置から調査を始めます。 たとえば、文字列 'abcdef' において 0 番目の位置にある文字は 'a' で 2 番目の位置にある文字は 'c' のようになります。

start に負の値を指定すると、 strspn()subject の最後から start 番目の位置から調査を始めます。

length

subject 内で調べる部分の長さ。

length に非負の値を指定すると、 subject の開始位置から length 文字ぶんの範囲を調査します。

length に負の値を指定すると、 subject の調査範囲は 開始位置から始まって subject の最後から length だけさかのぼったところまでとなります。

返り値

subject の中で、全て mask の中の文字からなる最初のセグメントの長さを返します。

変更履歴

バージョン 説明
4.3.0 start および length が追加されました。

例1 strspn() の例

<?php
// subjectの最初の文字がmaskのどの文字とも一致しません
var_dump(strspn("foo""o"));

// subject のオフセット 1 から 2 文字を調べます
var_dump(strspn("foo""o"12));

// subject のオフセット 1 から 1 文字を調べます
var_dump(strspn("foo""o"11));
?>

上の例の出力は以下となります。

int(0)
int(2)
int(1)

注意

注意: この関数はバイナリデータに対応しています。

参考

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

add a note add a note

User Contributed Notes 6 notes

up
3
B Crawford
6 years ago
This function is significantly faster for checking illegal characters than the equivalent preg_match() method.
up
2
barry dot balkowski at gmail dot com
5 years ago
It took me some time to understand the way this function works…
I’ve compiled my own explanation with my own words that is more understandable for me personally than the official one or those that can be found in different tutorials on the web.
Perhaps, it will save someone several minutes…

<?php
strspn
(string $haystack, string $char_list [, int $start [, int $length]])
?>

The way it works:
-   searches for a segment of $haystack that consists entirely from supplied through the second argument chars
-   $haystack must start from one of the chars supplied through $char_list, otherwise the function will find nothing
-   as soon as the function encounters a char that was not mentioned in $chars it understands that the segment is over and stops (it doesn’t search for the second, third and so on segments)
-   finally, it measures the segment’s length and return it (i.e. length)

In other words it finds a span (only the first one) in the string that consists entirely form chars supplied in $chars_list and returns its length
up
1
AT-HE (at_he.hotmail)
3 years ago
you can use this function with strlen to check illegal characters, string lenght must be the same than strspn (characters from my string contained in another)

<?php

$digits
='0123456789';

if (
strlen($phone) != strspn($phone,$digits))
echo
"illegal characters";

?>
up
1
Dmitry Mazur
5 years ago
The second parameter is a set of allowed characters.
strspn will return an zero-based index of a first non-allowed character.
up
1
mrsohailkhan at gmail dot com
3 years ago
very dificult to get from the definition directly, while i search for that,i came to know that

strspn() will tell you the length of a string consisting entirely of the set of characters in accept set. That is, it starts walking down str until it finds a character that is not in the set (that is, a character that is not to be accepted), and returns the length of the string so far.

and

strcspn() works much the same way, except that it walks down str until it finds a character in the reject set (that is, a character that is to be rejected.) It then returns the length of the string so far.

<?php
$acceptSet
= "aeiou";
$rejectSet  = "y";

$str1 ="a banana";
$str2 ="the bolivian navy on manuvers in the south pacific";

echo
$n = strspn($str1,$acceptSet);// $n == 1, just "a"

echo $n = strcspn($str2,$rejectSet);// n = 16, "the bolivian nav"
?>

hope this example will help in understanding the concept of strspn() and strcspn().
up
-1
bob at example dot com
2 years ago
Quick way to check if a string consists entirely of characters within the mask is to compare strspn with strlen eg:

<?php
$path
= $_SERVER['PATH_INFO'];
if (
strspn($path,'/') == strlen($path)) {
   
//PATH_INFO is empty
}
?>
To Top