strspn

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

strspn — 计算字符串中全部字符都存在于指定字符集合中的第一段子串的长度

说明

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

返回 string 中全部字符仅存在于 characters 中的第一组连续字符(子字符串)的长度。

如果省略了 offset 和 length 参数，则检查整个 string 字符串；如果指定了这两个参数，则效果等同于调用 strspn(substr($string, $offset, $length), $characters)（更多信息，参见 substr ）。

代码行：

<?php
$var = strspn("42 is the answer to the 128th question.", "1234567890");
?>

$var 将被指派为 2，因为 '42' 是 string 中第一段全部字符都存在于 '1234567890' 的连续字符。

参数

string

待检查的字符串。

characters

检查字符列表。

offset

string 的开始检查位置。

如果 offset 被设置并且是非负的，strspn() 将从 string 的第 offset 个位置开始检查。例如，在字符串 'abcdef' 中，第 0 个位置的字符是 'a'，第二个位置的字符是 'c'，等等。

如果 offset 被设置并且为负数，strspn() 将从 string 的尾部倒数第 offset 个位置开始检查 string。

length

string 中检查的长度。

如果 length 被设置并且为非负数，那么将从起始位置开始，检查 string 的 length 个长度的字符。

如果 length 被设置并且为负数，那么将从起始位置开始，直到从 string 尾部开始第 length 个位置，对 string 进行检查。

返回值

返回完全由 characters 中的字符组成的 string 初始段的长度。

注意:
当设置了 offset 参数时，返回的长度从此为止开始计算，而不是从 string 的开头开始计算。

更新日志

版本	说明
8.0.0	`length` 现在允许为 null。

示例

示例 #1 strspn() 示例

<?php
echo strspn("foo", "o", 1, 2); // 打印: 2
?>

以上示例会输出：

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

注释

注意: 此函数可安全用于二进制对象。

参见

strcspn() - 获取不匹配遮罩的起始子字符串的长度

add a note

User Contributed Notes 9 notes

down

barry dot balkowski at gmail dot com ¶

16 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

down

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";

?>

down

B Crawford ¶

17 years ago


This function is significantly faster for checking illegal characters than the equivalent preg_match() method.

down

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

down

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.

down

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

}

?>

down

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

?>

down

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
 */
?>

down

-7

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

add a note