strcspn

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

strcspn — Averiguar la longitud del segmento inicial que no coincida con una máscara

Descripción

strcspn(
    string $subject,
    string $mask,
    int $start = ?,
    int $length = ?
): int

Devuelve la longitud del segmento inicial de subject, el cual no contiene ningún caracter de mask.

Si se omiten start y length, se examinará subject al completo. Si se incluyen, el efecto será el mismo que una llamada a strcspn(substr($subject, $start, $length), $mask) (véase substr para más información).

Parámetros

subject

El string a examinar.

mask

El string que contiene cada caracter no permitido.

start

La posición en subject donde comenzar la búsqueda.

Si se proporciona start y no es negativo, strcspn() comenzará a examinar subject en la posición start-ésima. Por ejemplo, en el 'abcdef', el caracter en la posición 0 es 'a', el caracter en la posición 2 es 'c', etc.

Si se proporciona start y es negativo, strcspn() comenzará a examinar subject en la start-ésima a partir del final de subject.

length

La longitud del segmento de subject a examinar.

Si se proporcina length y no es negativo, subject será examinado desde length caracteres después de la posición inicial.

Si se proporcina length y es negativo, subject será examinado desde la posición inicial hasta length caracteres a partir del final de subject.

Valores devueltos

Devuelve la longitud del segmento inicial de subject, el cual consiste en todos los caracteres no presentes en mask.

Nota:
Cuando se establece el parámetro start, la longitud devuelta se cuenta a partir de esta posición, no desde el comienzo de subject.

Ejemplos

Ejemplo #1 Ejemplo de 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);
?>

El resultado del ejemplo sería:

int(0)
int(0)
int(2)
int(2)
int(5)
int(4)

Notas

Nota: Esta función es segura binariamente.

Ver también

strspn() - Averigua la longitud del segmento inicial de un string que consista únicamente en caracteres contenidos dentro de una máscara dada

add a note

User Contributed Notes 5 notes

down

maskedcoder at hotmail dot com ¶

19 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.

down

AT-HE (at_he AT hotmai1 DOT com) ¶

18 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";
}
?>

down

legacyprog at routinz dot net ¶

14 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.

down

nospam at nospam dot com ¶

8 years ago


It might not be clear from the example, that

strcspn('abcdhelloabcd', 'abcd', -9, -5) == 4

because it's only evaluating 'hell' which doesn't contain any mask, so returns strlen('hell').

down

Anonymous ¶

15 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');
?>

add a note