mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-25 17:32:07 +01:00
0ef4bced05
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@351916 c90b9560-bf6c-de11-be94-00142212c4b1
129 lines
4.0 KiB
XML
129 lines
4.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: e095023e408c8cb6378ae16bb6870343a3946919 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<refentry xml:id="function.str-pad" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>str_pad</refname>
|
|
<refpurpose>Complète une chaîne jusqu'à une taille donnée</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>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>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retourne la chaîne <parameter>string</parameter>,
|
|
complétée à droite, à gauche ou dans les deux sens, avec la
|
|
chaîne <parameter>pad_string</parameter> jusqu'à ce qu'elle
|
|
atteigne la taille de <parameter>length</parameter>.
|
|
</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, plus petite
|
|
que, ou égale à la taille courante de la chaîne <parameter>string</parameter>,
|
|
<parameter>string</parameter> est retournée inchangée et
|
|
<parameter>string</parameter> sera retourné.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pad_string</parameter></term>
|
|
<listitem>
|
|
<note>
|
|
<para>
|
|
Le paramètre <parameter>pad_string</parameter> peut être tronqué si le
|
|
nombre de caractères de complétion n'est pas multiple de la taille de
|
|
<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
|
|
l'une des constantes suivantes : <constant>STR_PAD_RIGHT</constant>,
|
|
<constant>STR_PAD_LEFT</constant>, ou <constant>STR_PAD_BOTH</constant>.
|
|
Si <parameter>pad_type</parameter> n'est pas spécifié, il
|
|
prend la valeur par défaut de <constant>STR_PAD_RIGHT</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retourne la chaîne complétée.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Exemple avec <function>str_pad</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$input = "Alien";
|
|
echo str_pad($input, 10); // produces "Alien "
|
|
echo str_pad($input, 10, "-=", STR_PAD_LEFT); // produces "-=-=-Alien"
|
|
echo str_pad($input, 10, "_", STR_PAD_BOTH); // produces "__Alien___"
|
|
echo str_pad($input, 6, "___"); // produces "Alien_"
|
|
echo str_pad($input, 3, "*"); // produces "Alien"
|
|
?>
|
|
]]>
|
|
</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
|
|
-->
|