doc-fr/reference/mbstring/functions/mb-str-pad.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e4e09f45c91ede64c7b7834eda71e4dfcdd3fd85 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.mb-str-pad" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mb_str_pad</refname>
  <refpurpose>Remplit une chaîne multioctets à une certaine longueur avec une autre chaîne multioctets</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_str_pad</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>pad_string</parameter><initializer>" "</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>pad_type</parameter><initializer><constant>STR_PAD_RIGHT</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Cette fonction renvoie le <parameter>string</parameter>
   remplit sur la gauche, la droite, ou les deux côtés à la longueur de
   remplissage spécifiée, où la longueur est mesurée en points de code Unicode. Si l'argument optionnel
   <parameter>pad_string</parameter> n'est pas fourni, le
   <parameter>string</parameter> est rempli avec des espaces, sinon il
   est rempli avec des caractères de <parameter>pad_string</parameter>
   jusqu'à la limite.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La chaîne d'entrée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Si la valeur de <parameter>length</parameter> est négative,
       inférieure ou égale à la longueur de la chaîne d'entrée, aucun remplissage
       n'a lieu, et <parameter>string</parameter> sera renvoyé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pad_string</parameter></term>
     <listitem>
      <note>
       <para>
        Le <parameter>pad_string</parameter> peut être tronqué si le
        nombre requis de caractères de remplissage ne peut pas être divisé
        de manière égale par la longueur du <parameter>pad_string</parameter>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pad_type</parameter></term>
     <listitem>
      <para>
       L'argument optionnel <parameter>pad_type</parameter> peut être
       <constant>STR_PAD_RIGHT</constant>, <constant>STR_PAD_LEFT</constant>,
       ou <constant>STR_PAD_BOTH</constant>.
       Par défaut <constant>STR_PAD_RIGHT</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Renvoie la chaîne remplie.
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mb_str_pad</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_RIGHT)); // string(18) "▶▶❤❓❇❤"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_LEFT));  // string(18) "❤❓❇❤▶▶"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_BOTH));  // string(18) "❤❓▶▶❤❓"

var_dump(mb_str_pad("🎉", 3, "祝", STR_PAD_LEFT));   // string(10) "祝祝🎉"
?>
]]>
    </programlisting>
   </example>
  </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
-->