strcspn
(PHP 4, PHP 5, PHP 7)
strcspn — Find length of initial segment not matching mask
Description
$subject
, string $mask
[, int $start
[, int $length
]] ) : int
Returns the length of the initial segment of
subject
which does not
contain any of the characters in mask
.
If start
and length
are omitted, then all of subject
will be
examined. If they are included, then the effect will be the same as
calling strcspn(substr($subject, $start, $length),
$mask) (see substr
for more information).
Parameters
-
subject
-
The string to examine.
-
mask
-
The string containing every disallowed character.
-
start
-
The position in
subject
to start searching.If
start
is given and is non-negative, then strcspn() will begin examiningsubject
at thestart
'th position. For instance, in the string 'abcdef', the character at position 0 is 'a', the character at position 2 is 'c', and so forth.If
start
is given and is negative, then strcspn() will begin examiningsubject
at thestart
'th position from the end ofsubject
. -
length
-
The length of the segment from
subject
to examine.If
length
is given and is non-negative, thensubject
will be examined forlength
characters after the starting position.If
length
is given and is negative, thensubject
will be examined from the starting position up tolength
characters from the end ofsubject
.
Return Values
Returns the length of the initial segment of subject
which consists entirely of characters not in mask
.
Note:
When a
start
parameter is set, the returned length is counted starting from this position, not from the beginning ofsubject
.
Examples
Example #1 strcspn() example
<?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);
?>
The above example will output:
int(0) int(0) int(2) int(2) int(5) int(4)
See Also
- strspn() - Finds the length of the initial segment of a string consisting entirely of characters contained within a given mask
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-strcspn.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.