mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
cd943f94a0
Partial merge of <https://github.com/php/doc-en/pull/266>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351860 c90b9560-bf6c-de11-be94-00142212c4b1
135 lines
3.7 KiB
XML
135 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.range" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>range</refname>
|
|
<refpurpose>Create an array containing a range of elements</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>
|
|
Create an array containing a range of elements.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>start</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
First value of the sequence.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>end</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The sequence is ended upon reaching the
|
|
<parameter>end</parameter> value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>step</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If a <parameter>step</parameter> value is given, it will be used as the
|
|
increment between elements in the sequence. <parameter>step</parameter>
|
|
should be given as a positive number. If not specified,
|
|
<parameter>step</parameter> will default to 1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array of elements from <parameter>start</parameter> to
|
|
<parameter>end</parameter>, inclusive.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>range</function> examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12)
|
|
foreach (range(0, 12) as $number) {
|
|
echo $number;
|
|
}
|
|
|
|
// The step parameter
|
|
// array(0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100)
|
|
foreach (range(0, 100, 10) as $number) {
|
|
echo $number;
|
|
}
|
|
|
|
// Usage of character sequences
|
|
// array('a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i');
|
|
foreach (range('a', 'i') as $letter) {
|
|
echo $letter;
|
|
}
|
|
// array('c', 'b', 'a');
|
|
foreach (range('c', 'a') as $letter) {
|
|
echo $letter;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Character sequence values are limited to a length of one. If a length greater
|
|
than one is entered, only the first character is used.
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|