doc-fr/reference/mbstring/functions/mb-strcut.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 92f1b8b177eb5730382abf9f27bae868f1bb636f Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_strcut</refname>
  <refpurpose>Coupe une partie de chaîne</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_strcut</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>start</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>mb_strcut</function> extrait une sous-chaîne depuis une chaîne, d'une
   façon similaire à la fonction <function>mb_substr</function>, mais opère sur
   les octets au lieu des caractères. Si le découpage intervient entre 2 octets
   d'un caractère multioctets, le découpage sera effectué au début du premier
   octet de ce caractère. C'est également la différence avec la fonction
   <function>substr</function> qui coupera la chaîne au milieu des octets,
   résultant ainsi en une séquence d'octets mal-formée.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La chaîne à couper.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Si <parameter>start</parameter> est positif, la chaîne
       retournée commencera à l'<emphasis>octet</emphasis> numéro <parameter>start</parameter>,
       dans la chaîne <parameter>string</parameter>. Le premier caractère
       est numéroté zéro. En effet, dans la chaîne '<literal>abcdef</literal>',
       l'octet à la position <literal>0</literal> est '<literal>a</literal>',
       l'octet à la position <literal>2</literal> est '<literal>c</literal>',
       et ainsi de suite.
      </para>
      <para>
       Si <parameter>start</parameter> est négatif, la chaîne retournée
       commencera à l'octet numéro <parameter>start</parameter> à compter
       de la fin de la chaîne <parameter>string</parameter>. Cependant, si le
       nombre négatif passé en paramètre <parameter>start</parameter> est supérieur
       à la longueur de la chaîne, la portion retournée commencera depuis
       le début de la chaîne <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Longueur en <emphasis>octets</emphasis>. Si ce
       paramètre est omis, ou vaut <literal>NULL</literal>,
       tous les octets jusqu'à la fin de la chaîne seront extraits.
      </para>
      <para>
       Si <parameter>length</parameter> est négatif, la chaîne retournée
       se finira à la position <parameter>length</parameter> en comptant
       en arrière depuis la fin de la chaîne <parameter>string</parameter>.
       Cependant, si le nombre négatif passé au paramètre
       <parameter>length</parameter> est plus grand que le nombre de caractères
       après la position <parameter>start</parameter>, une chaîne vide sera
       retourné.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>mb_strcut</function> retourne la portion de la chaîne
   <parameter>string</parameter> qui commence au caractère
   <parameter>start</parameter> et a la longueur de
   <parameter>length</parameter> caractères.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &mbstring.changelog.encoding-nullable;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_substr</function></member>
    <member><function>mb_internal_encoding</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
-->