Files
php-doc-ru/reference/array/functions/array-pad.xml
Max Chaban 9c1d07e404 Accepted review by Degit.
git-svn-id: https://svn.php.net/repository/phpdoc/ru/trunk@320307 c90b9560-bf6c-de11-be94-00142212c4b1
2011-12-03 09:28:19 +00:00

132 lines
4.5 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 568b98d64752c752101ebee0e9240d60e2bdc44d Maintainer: shein Status: ready -->
<!-- Reviewed: yes -->
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-pad">
<refnamediv>
<refname>array_pad</refname>
<refpurpose>Дополнить размер массива определенным значением до заданной величины</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_pad</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
<methodparam><type>int</type><parameter>pad_size</parameter></methodparam>
<methodparam><type>mixed</type><parameter>pad_value</parameter></methodparam>
</methodsynopsis>
<para>
Функция <function>array_pad</function> возвращает копию массива
<parameter>input</parameter>, дополненного до размера
<parameter>pad_size</parameter> элементами
со значением <parameter>pad_value</parameter>. Если параметр
<parameter>pad_size</parameter> положителен, то массив увеличивается
вправо, если отрицателен - влево. Если абсолютное значение
параметра <parameter>pad_size</parameter> меньше или равно
размеру массива <parameter>input</parameter>,
функция не производит никаких операций.
За один раз возможно добавить максимум 1048576 элементов.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
Исходный массив, к которому дополняются элементы.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pad_size</parameter></term>
<listitem>
<para>
Новый размер массива.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pad_value</parameter></term>
<listitem>
<para>
Дополняемое значение, если длина массива <parameter>input</parameter>
меньше <parameter>pad_size</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает копию <parameter>input</parameter>, дополненного до размера
указанного <parameter>pad_size</parameter> значением
<parameter>pad_value</parameter>. Если параметр <parameter>pad_size</parameter>
положителен, то массив дополняется вправо, если он отрицателен - влево.
Если абсолютное значение <parameter>pad_size</parameter> меньше
либо равно длине <parameter>input</parameter>, то дополнение не происходит.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>array_pad</function></title>
<programlisting role="php">
<![CDATA[
<?php
$input = array(12, 10, 9);
$result = array_pad($input, 5, 0);
// результат: array(12, 10, 9, 0, 0)
$result = array_pad($input, -7, -1);
// результат: array(-1, -1, -1, -1, 12, 10, 9)
$result = array_pad($input, 2, "noop");
// операция не произведена
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>array_fill</function></member>
<member><function>range</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
-->