archived-doc-ru/reference/strings/functions/str-pad.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.str-pad" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>str_pad</refname>
  <refpurpose>Дополняет строку другой строкой до заданной длины</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>str_pad</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>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><constant>STR_PAD_RIGHT</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция возвращает строку <parameter>string</parameter>,
   которую дополнила слева, справа или с обеих сторон до заданной длины.
   Функция дополнит параметр <parameter>string</parameter> пробелами,
   если необязательный аргумент <parameter>pad_string</parameter> не передали,
   иначе функция дополнит строку до нужной длины символами из параметра <parameter>pad_string</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Входная строка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Необходимая длина итоговой строки после дополнения.
       Функция не дополняет строку и возвращает
       исходную строку <parameter>string</parameter>,
       если значение <parameter>length</parameter> отрицательно,
       меньше или равно длине входной строки.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pad_string</parameter></term>
     <listitem>
      <note>
       <para>
        Функция урезает параметр <parameter>pad_string</parameter>,
        если требуемое количество символов дополнения не делится
        без остатка на длину строки <parameter>pad_string</parameter>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pad_type</parameter></term>
     <listitem>
      <para>
       Необязательный параметр <parameter>pad_type</parameter> принимает
       значение <constant>STR_PAD_RIGHT</constant>, <constant>STR_PAD_LEFT</constant>
       или <constant>STR_PAD_BOTH</constant>. Значение по умолчанию для параметра
       равняется <constant>STR_PAD_RIGHT</constant>, если не указали.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает дополненную строку.
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример дополнения строки функцией <function>str_pad</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$input = "Alien";

echo str_pad($input, 10), PHP_EOL;                      // Выводит "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT), PHP_EOL;  // Выводит "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH), PHP_EOL;   // Выводит "__Alien___"
echo str_pad($input,  6, "___"), PHP_EOL;               // Выводит "Alien_"
echo str_pad($input,  3, "*"), PHP_EOL;                 // Выводит "Alien"

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_str_pad</function></member>
   </simplelist>
  </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
-->