doc-fr/reference/strings/functions/strcspn.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 422bb032237525aaf50e6a43f33362a2c610a1d7 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.strcspn" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>strcspn</refname>
  <refpurpose>Trouve un segment de chaîne ne contenant pas certains caractères</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>strcspn</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>string</type><parameter>characters</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Retourne la taille du premier segment de <parameter>string</parameter>
   qui ne contient <emphasis>aucun</emphasis> des caractères de
   <parameter>characters</parameter>.
  </para>
  <para>
   Si <parameter>offset</parameter> et <parameter>length</parameter>
   sont omis, alors la totalité de <parameter>string</parameter>
   sera examinée. S'ils sont inclus, alors l'effet sera identique à
   appeler <literal>strcspn(substr($string, $offset, $length),
   $characters)</literal> (voir <xref linkend="function.substr"/> pour plus
   d'informations).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La chaîne à examiner.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>characters</parameter></term>
     <listitem>
      <para>
       La chaîne contenant tous les caractères désactivés.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       La position dans <parameter>string</parameter> à partir
       de laquelle on commence à chercher.
      </para>
      <para>
       Si <parameter>offset</parameter> est fourni et n'est pas négatif,
       alors <function>strcspn</function> va commencer à examiner
       <parameter>string</parameter> à la
       <parameter>offset</parameter> ème position. Par exemple, dans
       la chaîne '<literal>abcdef</literal>', le caractère à la position
       <literal>0</literal> est '<literal>a</literal>', le caractère
       à la position <literal>2</literal> est
       '<literal>c</literal>', et ainsi de suite.
      </para>
      <para>
       Si <parameter>offset</parameter> est fourni et est négatif,
       alors <function>strspn</function> va commencer à examiner
       <parameter>string</parameter> à la
       <parameter>offset</parameter> ème position depuis la fin de
       <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       La longueur du segment de <parameter>string</parameter>
       à examiner. 
      </para>
      <para>
       Si <parameter>length</parameter> est fourni et n'est pas négatif,
       alors <parameter>string</parameter> sera examiné
       depuis <parameter>length</parameter> caractères après la position de
       départ.
      </para>
      <para>
       Si <parameter>length</parameter> est fourni et est négatif,
       alors <parameter>string</parameter> sera examiné depuis la
       position de départ jusqu'à <parameter>length</parameter>
       caractères depuis la fin de <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la longueur du segment initial de <parameter>string</parameter>
   qui contient seulement des caractères qui ne sont <emphasis>pas</emphasis> 
   dans <parameter>characters</parameter>.
  </para>
  <note>
   <para>
    Lorsque le paramètre <parameter>offset</parameter> est définie, la
    longueur retournée est comptée depuis cette position, et non depuis
    le début de <parameter>string</parameter>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="strcspn.example">
   <title>Exemple avec <function>strcspn</function></title>
   <programlisting role="php">
<![CDATA[
<?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);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
int(0)
int(0)
int(2)
int(2)
int(5)
int(4)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>strspn</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->