mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 02:18:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
128 lines
3.7 KiB
XML
128 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-pad">
|
|
<refnamediv>
|
|
<refname>str_pad</refname>
|
|
<refpurpose>Pad a string to a certain length with another string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>str_pad</methodname>
|
|
<methodparam><type>string</type><parameter>input</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>pad_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>STR_PAD_RIGHT</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This functions returns the <parameter>input</parameter> string
|
|
padded on the left, the right, or both sides to the specified
|
|
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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>input</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pad_length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If the value of <parameter>pad_length</parameter> is negative,
|
|
less than, or equal to the length of the input string, no padding
|
|
takes place.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pad_string</parameter></term>
|
|
<listitem>
|
|
<note>
|
|
<para>
|
|
The <parameter>pad_string</parameter> may be truncated if the
|
|
required number of padding characters can't be evenly divided by the
|
|
<parameter>pad_string</parameter>'s length.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pad_type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Optional argument <parameter>pad_type</parameter> can be
|
|
<constant>STR_PAD_RIGHT</constant>, <constant>STR_PAD_LEFT</constant>,
|
|
or <constant>STR_PAD_BOTH</constant>. If
|
|
<parameter>pad_type</parameter> is not specified it is assumed to be
|
|
<constant>STR_PAD_RIGHT</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the padded string.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>str_pad</function> example</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_"
|
|
?>
|
|
]]>
|
|
</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
|
|
-->
|