From c9c117546e1bf4d9237ad360b3cdde60cff03761 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Thu, 30 Jun 2011 13:22:55 +0000
Subject: [PATCH] scandir constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@312682 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/dir/constants.xml         | 40 ++++++++++++++++++++++++-----
 reference/dir/functions/scandir.xml | 33 +++++++++++++++++++++---
 2 files changed, 64 insertions(+), 9 deletions(-)

diff --git a/reference/dir/constants.xml b/reference/dir/constants.xml
index 435674bc6a..e72b99906f 100644
--- a/reference/dir/constants.xml
+++ b/reference/dir/constants.xml
@@ -22,16 +22,44 @@
    </term>
    <listitem>
     <simpara>
-
+     Available since PHP 4.3.0.
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>SCANDIR_SORT_ASCENDING</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+     Available since PHP 5.4.0.
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>SCANDIR_SORT_DESCENDING</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+     Available since PHP 5.4.0.
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>SCANDIR_SORT_NONE</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+     Available since PHP 5.4.0.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
- <note>
-  <simpara>
-   The <constant>PATH_SEPARATOR</constant> was introduced with PHP 4.3.0-RC2.
-  </simpara>
- </note>
 </appendix>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/dir/functions/scandir.xml b/reference/dir/functions/scandir.xml
index d1caaae065..2563e10a6f 100644
--- a/reference/dir/functions/scandir.xml
+++ b/reference/dir/functions/scandir.xml
@@ -11,7 +11,7 @@
   <methodsynopsis>
    <type>array</type><methodname>scandir</methodname>
    <methodparam><type>string</type><parameter>directory</parameter></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>sorting_order</parameter><initializer>0</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>sorting_order</parameter><initializer>SCANDIR_SORT_ASCENDING</initializer></methodparam>
    <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -38,8 +38,10 @@
      <listitem>
       <para>
        By default, the sorted order is alphabetical in ascending order.  If
-       the optional <parameter>sorting_order</parameter> is set to non-zero,
-       then the sort order is alphabetical in descending order.
+       the optional <parameter>sorting_order</parameter> is set to
+       <constant>SCANDIR_SORT_DESCENDING</constant>, then the sort order is
+       alphabetical in descending order. If it is set to
+       <constant>SCANDIR_SORT_NONE</constant> then the result is unsorted.
       </para>
      </listitem>
     </varlistentry>
@@ -67,6 +69,31 @@
   </para> 
  </refsect1>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>5.4.0</entry>
+       <entry>
+        <parameter>sorting_order</parameter> now accepts constants. Any
+        nonzero value caused descending order in previous versions.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>