From fece0b4dcb292fd5f327a33bd2487bd7f71731d0 Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Tue, 2 Mar 2010 01:50:22 +0000
Subject: [PATCH] Fixed bug #51157 (The "recursive" parameter for mkdir is not
documented.)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@295712 c90b9560-bf6c-de11-be94-00142212c4b1
---
reference/filesystem/functions/mkdir.xml | 27 +++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
diff --git a/reference/filesystem/functions/mkdir.xml b/reference/filesystem/functions/mkdir.xml
index 00e0337a1f..e3ad8fc22f 100644
--- a/reference/filesystem/functions/mkdir.xml
+++ b/reference/filesystem/functions/mkdir.xml
@@ -57,7 +57,8 @@
<term><parameter>recursive</parameter></term>
<listitem>
<para>
- Default to &false;.
+ Allows the creation of nested directories specified in the
+ <parameter>pathname</parameter>. Defaults to &false;.
</para>
</listitem>
</varlistentry>
@@ -127,6 +128,30 @@
<?php
mkdir("/path/to/my/dir", 0700);
?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title><function>mkdir</function> using the <parameter>recursive</parameter> parameter</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+/* Desired folder structure */
+$structure = './depth1/depth2/depth3/';
+
+/* To create the nested structure, the $recursive parameter
+ * to mkdir() must be specified.
+ */
+
+if(!mkdir($structure, 0, true))
+{
+ die('Failed to create folders...');
+}
+
+/* ... */
+?>
]]>
</programlisting>
</example>