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
strspn
(PHP 4, PHP 5, PHP 7, PHP 8)
strspn — 指定したマスク内に含まれる文字からなる文字列の最初のセグメントの長さを探す
説明
string の中で、
characters 内の文字だけを含む最初の部分の長さを返します。
offset と length
を省略した場合は、string 全体を調べます。
指定した場合は、strspn(substr($string, $offset, $length),
$characters) をコールするのと同じ動きになります。
(詳細は substr を参照ください)
たとえば、
<?php
$var = strspn("42 is the answer to the 128th question.", "1234567890");
?>2 を代入します。これは、
string の中で "1234567890" 内の文字だけで構成される
最初の部分が "42" であるためです。
パラメータ
-
string -
調べたい文字列。
-
characters -
許可する文字の一覧。
-
offset -
stringの中で調べ始める位置。offsetに非負の値を指定すると、 strspn() はstringのoffset番目の位置から調査を始めます。 たとえば、文字列 'abcdef' において0番目の位置にある文字は 'a' で2番目の位置にある文字は 'c' のようになります。offsetに負の値を指定すると、 strspn() はstringの最後からoffset番目の位置から調査を始めます。 -
length -
string内で調べる部分の長さ。lengthに非負の値を指定すると、stringの開始位置からlength文字分の範囲を調査します。lengthに負の値を指定すると、stringの調査範囲は 開始位置から始まってstringの最後からlengthだけさかのぼったところまでとなります。
戻り値
string の中で、全て
characters の中の文字からなる最初のセグメントの長さを返します。
注意:
offsetパラメータを設定した場合は、返される長さはその位置からのものとなります。stringの先頭からの長さではありません。
変更履歴
| バージョン | 説明 |
|---|---|
| 8.0.0 |
length は、nullable になりました。
|
例
例1 strspn() の例
<?php
// subjectの最初の文字がmaskのどの文字とも一致しません
var_dump(strspn("foo", "o"));
// subject のオフセット 1 から 2 文字を調べます
var_dump(strspn("foo", "o", 1, 2));
// subject のオフセット 1 から 1 文字を調べます
var_dump(strspn("foo", "o", 1, 1));
?>上の例の出力は以下となります。
int(0) int(2) int(1)
注意
注意: この関数はバイナリデータに対応しています。
add a note
User Contributed Notes 9 notes
barry dot balkowski at gmail dot com ¶
16 years ago
AT-HE (at_he.hotmail) ¶
13 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";
?>
B Crawford ¶
17 years ago
This function is significantly faster for checking illegal characters than the equivalent preg_match() method.
mrsohailkhan at gmail dot com ¶
13 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().
Dmitry Mazur ¶
15 years ago
The second parameter is a set of allowed characters.
strspn will return an zero-based index of a first non-allowed character.
bob at example dot com ¶
12 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
}
?>
lincoln dot mahmud at gmail dot com ¶
4 years ago
Get Group match letter
<?php
$s= 'aaabbbcceeffaaeeeaaabbzmmm';
function groupby( $s ){
static $a = [];
static $i = 0;
$o = strspn( $s, $s[$i], $i);
$a[ $i ] = [ $s[$i] => $o ];
$i += $o;
if( $i < strlen($s) ) {
groupby($s);
}
return $a;
}
print_r(groupby($s));
?>
nino dot skopac at gmail dot com ¶
6 years ago
strspon and preg_match seem to be equally fast for validating numbers:
<?php
$testValInvalid = 'foobar123^^';
$testValValid = '12346';
$allowedChars = '1234567890';
$t1 = microtime(true);
for ($i = 0; $i < 1000000; $i++) {
assert(strspn($testValInvalid, $allowedChars) != strlen($testValInvalid));
assert(strspn($testValValid, $allowedChars) == strlen($testValValid));
}
print 'Time taken for strspon: ' . (microtime(true) - $t1);
print PHP_EOL;
$t1 = microtime(true);
for ($i = 0; $i < 1000000; $i++) {
assert(preg_match('/^[0-9]+$/', $testValInvalid) === 0);
assert(preg_match('/^[0-9]+$/', $testValValid));
}
print 'Time taken for preg_match: ' . (microtime(true) - $t1);
print PHP_EOL;
/**
nino-mcb:hosp_web ninoskopac$ php test.php
Time taken for strspon: 3.24165391922
Time taken for preg_match: 3.1820080280304
nino-mcb:hosp_web ninoskopac$ php test.php
Time taken for strspon: 3.1806418895721
Time taken for preg_match: 3.2244551181793
*/
?>
ayaou dot mohammed at gmail dot com ¶
5 years ago
This function doesn't work with non ASCII characters
Exemple:
<?php
$subject = "Comment ça va ma chérie";
$mask = "éèçà";
echo strspn($subject,$mask); // Echo 0
?>
See, we expected 1 but 0 was the correct result
