<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 647d5c50e3b6c103a3efdb578fd227f8b923399d Maintainer: shein Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.range" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>range</refname>

<refpurpose>Создаёт массив, который содержит диапазон элементов</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>array</type><methodname>range</methodname>

<methodparam><type class="union"><type>string</type><type>int</type><type>float</type></type><parameter>start</parameter></methodparam>

<methodparam><type class="union"><type>string</type><type>int</type><type>float</type></type><parameter>end</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>int</type><type>float</type></type><parameter>step</parameter><initializer>1</initializer></methodparam>

</methodsynopsis>

<para>

Функция создаёт массив, который содержит диапазон элементов.

</para>

<para>

Функция создаёт массив последовательных байтов, если в параметры <parameter>start</parameter>

и <parameter>end</parameter> передали значения с типом <type>string</type>,

а в параметр <parameter>step</parameter> значение с типом <type>int</type>.

В остальных случаях создаётся массив последовательных чисел.

</para>

<para>

Последовательность возрастает, если значение аргумента <parameter>start</parameter>

меньше численного эквивалента аргумента <parameter>end</parameter>,

иначе последовательность убывает.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>start</parameter></term>

<listitem>

<para>

Первое значение последовательности.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>end</parameter></term>

<listitem>

<para>

Последнее значение последовательности.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>step</parameter></term>

<listitem>

<para>

Параметр <parameter>step</parameter> указывает шаг продвижения

между значениями последовательности.

</para>

<para>

В параметр <parameter>step</parameter> передают отрицательное значение, чтобы создать убывающую последовательность.

</para>

<para>

Параметр <parameter>step</parameter> интерпретирует значения <type>float</type>

без дробной части как значения <type>int</type>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Функция возвращает массив (<type>array</type>) последовательных элементов,

которые начинаются со значения <parameter>start</parameter>

и продвигаются к значению <parameter>end</parameter> с шагом <parameter>step</parameter>.

</para>

<para>

На значение последнего элемента возвращаемого массива влияет параметр <parameter>step</parameter>:

последовательность завершается либо значением <parameter>end</parameter>,

либо значением, которое предшествует выходу за пределы диапазона.

</para>

<para>

Функция создаст массив последовательных байтов,

если в параметры <parameter>start</parameter> и <parameter>end</parameter> передали значения с типом <type>string</type>,

а в параметр <parameter>step</parameter> значение с типом <type>int</type>.

Функцию большей частью вызывают, чтобы получить последовательность латинских ASCII-символов.

</para>

<para>

Функция вернёт массив последовательных значений <type>float</type>,

если хотя бы в один параметр <parameter>start</parameter>, <parameter>end</parameter>,

или <parameter>step</parameter> передали значение <type>float</type>.

</para>

<para>

В остальных случаях возвращается массив, который содержит последовательность значений <type>int</type>.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<itemizedlist>

<listitem>

<simpara>

При передаче в параметр <parameter>step</parameter> значения <literal>0</literal>

функция выбросит ошибку <classname>ValueError</classname>.

</simpara>

</listitem>

<listitem>

<simpara>

При передаче хотя бы в один параметр <parameter>start</parameter>, <parameter>end</parameter>,

или <parameter>step</parameter> неконечного числа, как его определяет функция <function>is_finite</function>,

функция выбросит ошибку <classname>ValueError</classname>.

</simpara>

</listitem>

<listitem>

<simpara>

При передаче в параметр <parameter>step</parameter> отрицательного значения

для возрастающего диапазона, для которого выполняется условие <code>$start &lt;= $end</code>,

функция выбросит ошибку <classname>ValueError</classname>.

</simpara>

</listitem>

<listitem>

<simpara>

При передаче в параметр <parameter>start</parameter> или <parameter>end</parameter>

пустой строки <literal>''</literal> функция выдаёт ошибку уровня <constant>E_WARNING</constant>,

а пустая строка интерпретируется как <literal>0</literal>.

</simpara>

</listitem>

<listitem>

<simpara>

При передаче в параметр <parameter>start</parameter> или <parameter>end</parameter>

<link linkend="language.types.numeric-strings">нечисловой строки</link>

размером больше одного байта функция сгенерирует ошибку уровня <constant>E_WARNING</constant>.

</simpara>

</listitem>

<listitem>

<simpara>

При передаче в параметр <parameter>start</parameter> или <parameter>end</parameter> строки,

которая неявно приводится к значению <type>int</type>, поскольку другое граничное значение — число,

возникнет ошибка уровня <constant>E_WARNING</constant>.

</simpara>

</listitem>

<listitem>

<simpara>

Функция сгенерирует ошибку уровня <constant>E_WARNING</constant>,

если в параметр <parameter>step</parameter> передали значение <type>float</type>,

а в параметры <parameter>start</parameter> и <parameter>end</parameter>

<link linkend="language.types.numeric-strings">нечисловую строку</link>.

</simpara>

</listitem>

</itemizedlist>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.3.0</entry>

<entry>

Функция <function>range</function> теперь создаёт массив (<type>array</type>) байтов,

если в оба параметра <parameter>start</parameter> и <parameter>end</parameter>

передали строки. Раньше при передаче числовой строки хотя бы в одном граничном значении

другое граничное значение неявно приводились к типу <type>int</type>.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Функция теперь выдаёт ошибку уровня <constant>E_WARNING</constant>,

если в параметр <parameter>start</parameter> или <parameter>end</parameter>

передали строку, которая неявно приводится к типу <type>int</type>,

поскольку другое граничное значение — число.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Функция теперь выдаёт ошибку уровня <constant>E_WARNING</constant>,

если в параметр <parameter>start</parameter> или <parameter>end</parameter>

передали нечисловую строку размером больше одного байта.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Функция теперь выдаёт ошибку уровня <constant>E_WARNING</constant>,

если в параметр <parameter>start</parameter> или <parameter>end</parameter>

передали пустую строку.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Параметр <parameter>step</parameter> теперь интерпретирует значения <type>float</type>

без дробной части как значения <type>int</type>.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Функция теперь выбрасывает ошибку <classname>ValueError</classname>

при передаче в параметр <parameter>step</parameter> отрицательного значения для возрастающего диапазона.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Функция теперь выбрасывает ошибку <classname>ValueError</classname>,

если в параметр <parameter>step</parameter> передали неконечное числовое значение.

</entry>

</row>

<row>

<entry>8.3.0</entry>

<entry>

Функция теперь выбрасывает ошибку <classname>TypeError</classname>,

если в параметр <parameter>start</parameter> или <parameter>end</parameter>

передали значение <type>array</type>, <type>object</type> или <type>resource</type>.

Раньше такие значения неявно приводились к значению <type>int</type>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Примеры создания диапазона значений функцией <function>range</function></title>

<programlisting role="php">

<![CDATA[

<?php

echo implode(', ', range(0, 12)), PHP_EOL;

echo implode(', ', range(0, 100, 10)), PHP_EOL;

echo implode(', ', range('a', 'i')), PHP_EOL;

echo implode(', ', range('c', 'a')), PHP_EOL;

echo implode(', ', range('A', 'z')), PHP_EOL;

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100

a, b, c, d, e, f, g, h, i

c, b, a

A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, [, \, ], ^, _, `, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>shuffle</function></member>

<member><function>array_fill</function></member>

<member>&foreach;</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

-->