PhpDig.net

What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.




str_pad

Name

str_pad — Pads a string with arbitrary characters.

Synopsis

string str_pad(string, length[, pad_string][, pad_end]);
string string: String to be padded
int length: Desired string length
string pad_string (optional): String to use for padding
int pad_end (optional): Flag that controls whether right, left, or both ends of the string are padded

Returns

String; NULL on error

Description

str_pad() is used to pad a string to length length using the characters in pad_string . If pad_string is not specified, spaces are used.

When more than one character is used for pad_string , the padding is generated by repeating the pad_string from left to right until the desired length is reached. Any extra characters are truncated.

If the amount of padding specified is less than the length of string , no padding takes place.

Padding is assumed to be added to the right end of the string, unless pad_end is specified. Valid values for pad_end are detailed in the following table.

Named Constant Description
STR_PAD_BOTH Pad both ends of the string. If the amount of padding cannot be evenly divided between each side, the right side gets the extra padding.
STR_PAD_LEFT Pad the left end of the string.
STR_PAD_RIGHT Default; pad the right end of the string.


Version

PHP 4.0.1+

See also

To print or make a formatted string:

printf()

sprintf()



Example

Example 1226. Print a centered list

<?php
$cities = array(
   'Abtu','Abu','Anu','Bast','Hensu','Het-ka-Ptah','Khemenu','Per-Menu',
   'Qerrt','SauSais','Sekhem','Suat','Tetu','Two Lands','Unu'
);

foreach($cities as $city) {
   echo str_pad($city, 40, '.', STR_PAD_BOTH), "\n";
}
?>

Output:
..................Abtu..................
..................Abu...................
..................Anu...................
..................Bast..................
.................Hensu..................
..............Het-ka-Ptah...............
................Khemenu.................
................Per-Menu................
.................Qerrt..................
................SauSais.................
.................Sekhem.................
..................Suat..................
..................Tetu..................
...............Two Lands................
..................Unu...................



PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.

Powered by: vBulletin Version 3.0.7
Copyright ©2000 - 2005, Jelsoft Enterprises Ltd.
Copyright © 2001 - 2005, ThinkDing LLC. All Rights Reserved.