strcspn

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

    strcspn — Encontra o tamanho do segmento inicial que não corresponde à máscara

    Descrição

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

    Retorna o tamanho do segmento inicial de string que não contiver nenhum dos caracteres definidos no parâmetro characters.

    Se offset e length forem omitidos, então tudo da string será examinado. Se forem incluídos, então o efeito será o mesmo que chamar strcspn(substr($string, $offset, $length), $characters) (consulte substr para mais informações).

    Parâmetros

    string

    O string a ser examinado.

    characters

    A string contendo os caracteres não permitidos.

    offset

    A posição na string para iniciar a pesquisa.

    Se offset for informado e não negativo, a função strcspn() começará a examinar a string na posição offset. Por exemplo, na string 'abcdef', o caractere na posição 0 é 'a', na posição 2 é 'c', e assim por diante.

    Se offset for informado e negativo, a função strcspn() começará a examinar a string na posição offset a partir do final da string.

    length

    O tamanho do segmento da string a ser examinado.

    Se length for informado e não negativo, a string será examinada pelo número de caracteres em length a partir da posição inicial.

    Se length for informado e negativo, a string será examinada a partir da posição inicial até o número de caracteres informado em length contados a partir do final da string.

    Valor Retornado

    Retorna o tamanho do segmento inicial da string que consiste inteiramente de caracteres que não estejam em characters.

    Nota:

    Quando offset estiver definido, o tamanho retornado é contado a partir deste posição, e não a partir do início da string.

    Registro de Alterações

    Versão Descrição
    8.4.0 Antes do PHP 8.4.0, quando characters fosse uma string vazia, a pesquisa incorretamente encerraria no primeiro byte nulo em string.
    8.0.0 length agora pode ser nulo.

    Exemplos

    Exemplo #1 Exemplo de strcspn()

    <?php
$a = strcspn('banana', 'a');
$b = strcspn('banana', 'abcd');
$c = strcspn('banana', 'z');
$d = strcspn('abcdhelloabcd', 'a', -9);
$e = strcspn('abcdhelloabcd', 'a', -9, -5);

var_dump($a);
var_dump($b);
var_dump($c);
var_dump($d);
var_dump($e);
?>

    O exemplo acima produzirá:

    int(1)
int(0)
int(6)
int(5)
int(4)

    Notas

    Nota: Esta função é compatível com dados binários.

    Veja Também

    • strspn() - Encontra o comprimento do segmento inicial de uma string composta totalmente de caracteres contidos em uma máscara informada

    Melhore Esta Página

    Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema
    ＋adicionar nota

    Notas de Usuários 5 notes

    up
    13
    AT-HE (at_he AT hotmai1 DOT com)
    20 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";
}
?>
    up
    10
    maskedcoder at hotmail dot com
    20 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.
    up
    4
    legacyprog at routinz dot net
    15 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.
    up
    4
    Anonymous
    16 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');
?>
    up
    2
    nospam at nospam dot com
    9 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').
    ＋adicionar nota
    To Top