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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.22 $ -->
<!-- EN-Revision: 1.18 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.wordwrap">
 <refnamediv>
  <refname>wordwrap</refname>
  <refpurpose>Effectue la césure d'une chaîne</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>wordwrap</methodname>
   <methodparam><type>string</type><parameter>str</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>width</parameter><initializer>75</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>break</parameter><initializer>"\n"</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>cut</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   Effectue la césure d'une chaîne.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>str</parameter></term>
     <listitem>
      <para>
       La chaîne d'entrée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       La largeur de la colonne. Par défaut, 75.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>break</parameter></term>
     <listitem>
      <para>
       La ligne est rompue en utilisant ce paramètre optionnel.
       Par défaut, il vaut '<literal>\n</literal>'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cut</parameter></term>
     <listitem>
      <para>
       Si le paramètre <parameter>cut</parameter> vaut &true;, la césure de
       la chaîne sera toujours à la taille <parameter>width</parameter>. Si vous
       avez un mot qui est plus long que la taille de césure, il sera
       coupé en morceaux. (Voir le second exemple.)
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la chaîne <parameter>str</parameter>, après avoir inséré
   <parameter>break</parameter> tous les <parameter>width</parameter>
   caractères.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.0.3</entry>
       <entry>
        Ajout du paramètre optionnel <parameter>cut</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>wordwrap</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$text = "Portez ce vieux whisky au juge blond qui fume.";
$newtext = wordwrap($text, 20, "<br />\n");

echo $newtext;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Portez ce vieux<br />
whisky au juge<br />
blond qui fume.
]]>
    </screen>
   </example>
   <example>
    <title>Exemple avec <function>wordwrap</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$text = "Un mot très très loooooooooooooooooong.";
$newtext = wordwrap($text, 8, "\n", true);

echo "$newtext\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Un mot
très
très
looooooo
oooooooo
ooong.
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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