From 2296ac3de9bcbee35ea8e5e86b8fc427167261ec Mon Sep 17 00:00:00 2001
From: Andrei Zmievski <andrei@php.net>
Date: Sat, 8 Jul 2000 20:50:51 +0000
Subject: [PATCH] Documentation for str_pad().

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@27883 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/strings.xml | 56 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/functions/strings.xml b/functions/strings.xml
index ce3955a5c3..6c2fdb3e91 100644
--- a/functions/strings.xml
+++ b/functions/strings.xml
@@ -1902,6 +1902,62 @@ if (!strcasecmp ($var1, $var2)) {
    </refsect1>
   </refentry>
 
+  <refentry id="function.str-pad">
+   <refnamediv>
+    <refname>str_pad</refname>
+    <refpurpose>Pad a string to a certain length with another string</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>string <function>str_pad</function></funcdef>
+      <paramdef>string <parameter>input</parameter></paramdef>
+      <paramdef>int <parameter>pad_length</parameter></paramdef>
+      <paramdef>string
+       <parameter><optional>pad_string</optional></parameter></paramdef>
+      <paramdef>int
+       <parameter><optional>pad_type</optional></parameter>
+      </paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     This functions pads the <parameter>input</parameter> string on
+     the left, the right, or both sides to the specifed padding
+     length. If the optional argument
+     <parameter>pad_string</parameter> is not supplied, the
+     <parameter>input</parameter> is padded with spaces, otherwise it
+     is padded with characters from <parameter>pad_string</parameter>
+     up to the limit.
+    </para>
+
+    <para>
+     Optional argument <parameter>pad_type</parameter> can be
+     STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH.  If
+     <parameter>pad_type</parameter> is not specified it is assumed to
+     be STR_PAD_RIGHT.
+    </para>
+    
+    <para>
+      If the value of <parameter>pad_length</parameter> is negative or
+      less than the length of the input string, no padding takes
+      place.
+    </para>
+
+    <para>
+     <example>
+      <title><function>str_pad</function> example</title>
+      <programlisting role="php">
+$input = "Alien";
+print str_pad($input, 10);                      // produces "Alien     "
+print str_pad($input, 10, "-=", STR_PAD_LEFT);  // produces "-=-=-Alien"
+print str_pad($input, 10, "_", STR_PAD_BOTH);   // produces "__Alien___"
+      </programlisting>
+     </example>
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.strpos">
    <refnamediv>
     <refname>strpos</refname>