str_pad

(PHP 4 >= 4.0.1, PHP 5)

str_pad --  Complète une chaîne jusqu'à une taille donnée

Description

string str_pad ( string input, int pad_length [, string pad_string [, int pad_type]] )

str_pad retourne la chaîne input, complétée à droite, à gauche ou dans les deux sens, avec la chaîne pad_string jusqu'à ce qu'elle atteigne la taille de pad_length. Si le paramètre optionnel pad_string est omis, input sera complétée avec des espaces. Sinon, cette chaîne sera utilisée.

L'argument optionnel pad_type peut être l'une des constantes suivantes : STR_PAD_RIGHT, STR_PAD_LEFT, ou STR_PAD_BOTH. Si pad_type n'est pas spécifié, il prend la valeur par défaut de STR_PAD_RIGHT.

Si la valeur de pad_length est négative, ou inférieure à la taille courante de la chaîne input, input est retournée inchangée.

Exemple 1. Exemple avec str_pad()

<?php
$input
= "Alien";
echo
str_pad($input, 10);                      // affiche "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT);  // affiche "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH);   // affiche "__Alien___"
echo str_pad($input, 6 , "___");               // affiche "Alien_"
?>

Note : Le paramètre pad_string peut être tronqué si le nombre de caractères de complétion n'est pas multiple de la taille de pad_string.