philip Thu Dec 26 11:52:16 2002 EDT
Modified files:
/phpdoc/en/reference/array/functions range.xml
Log:
Removed older example for pre 4.1.0 (was a little confusing), reformated
the example to be outside the <note>, made the parameter changes clearer.
Added more comments to the examples. See also foreach.
Index: phpdoc/en/reference/array/functions/range.xml
diff -u phpdoc/en/reference/array/functions/range.xml:1.5
phpdoc/en/reference/array/functions/range.xml:1.6
--- phpdoc/en/reference/array/functions/range.xml:1.5 Thu Nov 14 00:57:58 2002
+++ phpdoc/en/reference/array/functions/range.xml Thu Dec 26 11:52:16 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry id="function.range">
<refnamediv>
@@ -21,57 +21,59 @@
<parameter>low</parameter> to <parameter>high</parameter>,
inclusive. If low > high, the sequence will be from high to low.
</para>
+ <note>
+ <title>New parameter</title>
+ <simpara>
+ The optional <parameter>step</parameter> parameter was added in 4.4.0.
+ </simpara>
+ </note>
<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>
- <example>
- <title><function>range</function> examples</title>
- <programlisting role="php">
+ <para>
+ <example>
+ <title><function>range</function> examples</title>
+ <programlisting role="php">
<![CDATA[
+<?php
+// array(0,1,2,3,4,5,6,7,8,9)
foreach(range(0, 9) as $number) {
echo $number;
}
+
+// The step parameter was introduced in 4.4.0
+// array(0,10,20,30,40,50,60,70,80,90,100)
foreach(range(0, 100, 10) as $number) {
echo $number;
}
-foreach(range('a', 'z') as $letter) {
+
+// Use of characters introduced in 4.1.0
+// array('a','b','c','d','e','f','g','h','i');
+foreach(range('a', 'i') as $letter) {
echo $letter;
}
-foreach(range('z', 'a') as $letter) {
+// array('c','b','a');
+foreach(range('c', 'a') as $letter) {
echo $letter;
}
+?>
]]>
- </programlisting>
- </example>
+ </programlisting>
+ </example>
+ </para>
<note>
<para>
Prior to version 4.1.0 the <function>range</function> function
only generated incrementing integer arrays. Support for
character sequences and decrementing arrays was added in 4.1.0.
- The <parameter>step</parameter> parameter was added in 4.4.0.
</para>
- <example>
- <title>Simulating decrementing ranges and character sequences</title>
- <programlisting role="php">
-<![CDATA[
-# array_reverse can be used to flip the order of a range
-foreach(array_reverse(range(0,9)) as $number) {
- echo $number;
-}
-
-# array_map() can be used to turn integers into characters using chr()
-foreach(array_map('chr', range(ord('a'),ord('z'))) as $character) {
- echo $character;
-}
-]]>
- </programlisting>
- </example>
</note>
<para>
- See <function>shuffle</function> for another example of its use.
+ See also <function>shuffle</function> and
+ <link linkend="control-structures.foreach">foreach</link>.
</para>
</refsect1>
</refentry>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php