File: function.str-pad.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (269 lines) | stat: -rw-r--r-- 3,701 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>str_pad</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="String functions"
HREF="ref.strings.html"><LINK
REL="PREVIOUS"
TITLE="strncmp"
HREF="function.strncmp.html"><LINK
REL="NEXT"
TITLE="strpos"
HREF="function.strpos.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.strncmp.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.strpos.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.str-pad"
>str_pad</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN37458"
></A
><P
>    (PHP4 &#62;= 4.0.1)</P
>str_pad&nbsp;--&nbsp;Pad a string to a certain length with another string</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN37461"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN37463"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>string <B
CLASS="function"
>str_pad</B
></CODE
> (string input, int pad_length [, string
       pad_string [, int
       pad_type]])</CODE
></P
><P
></P
></DIV
><P
>&#13;     This functions pads the <TT
CLASS="parameter"
><I
>input</I
></TT
> string on
     the left, the right, or both sides to the specifed padding
     length. If the optional argument
     <TT
CLASS="parameter"
><I
>pad_string</I
></TT
> is not supplied, the
     <TT
CLASS="parameter"
><I
>input</I
></TT
> is padded with spaces, otherwise it
     is padded with characters from <TT
CLASS="parameter"
><I
>pad_string</I
></TT
>
     up to the limit.
    </P
><P
>&#13;     Optional argument <TT
CLASS="parameter"
><I
>pad_type</I
></TT
> can be
     STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH.  If
     <TT
CLASS="parameter"
><I
>pad_type</I
></TT
> is not specified it is assumed to
     be STR_PAD_RIGHT.
    </P
><P
>&#13;      If the value of <TT
CLASS="parameter"
><I
>pad_length</I
></TT
> is negative or
      less than the length of the input string, no padding takes
      place.
    </P
><P
>&#13;     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN37488"
></A
><P
><B
>Example 1. <B
CLASS="function"
>str_pad()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;$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___"
      </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.strncmp.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.strpos.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>strncmp</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.strings.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>strpos</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>