1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en" lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=utf-8" />
6 <title>Directory Helper : CodeIgniter User Guide
</title>
8 <style type='text/css' media='all'
>@import url('../userguide.css');
</style>
9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css'
/>
11 <script type=
"text/javascript" src=
"../nav/nav.js"></script>
12 <script type=
"text/javascript" src=
"../nav/prototype.lite.js"></script>
13 <script type=
"text/javascript" src=
"../nav/moo.fx.js"></script>
14 <script type=
"text/javascript" src=
"../nav/user_guide_menu.js"></script>
16 <meta http-equiv='expires' content='-
1'
/>
17 <meta http-equiv= 'pragma' content='no-cache'
/>
18 <meta name='robots' content='all'
/>
19 <meta name='author' content='ExpressionEngine Dev Team'
/>
20 <meta name='description' content='CodeIgniter User Guide'
/>
25 <!-- START NAVIGATION -->
26 <div id=
"nav"><div id=
"nav_inner"><script type=
"text/javascript">create_menu('../');
</script></div></div>
27 <div id=
"nav2"><a name=
"top"></a><a href=
"javascript:void(0);" onclick=
"myHeight.toggle();"><img src=
"../images/nav_toggle_darker.jpg" width=
"154" height=
"43" border=
"0" title=
"Toggle Table of Contents" alt=
"Toggle Table of Contents" /></a></div>
29 <table cellpadding=
"0" cellspacing=
"0" border=
"0" style=
"width:100%">
31 <td><h1>CodeIgniter User Guide Version
2.1.3</h1></td>
32 <td id=
"breadcrumb_right"><a href=
"../toc.html">Table of Contents Page
</a></td>
36 <!-- END NAVIGATION -->
39 <!-- START BREADCRUMB -->
41 <table cellpadding=
"0" cellspacing=
"0" border=
"0" style=
"width:100%">
44 <a href=
"http://codeigniter.com/">CodeIgniter Home
</a> ›
45 <a href=
"../index.html">User Guide Home
</a> ›
48 <td id=
"searchbox"><form method=
"get" action=
"http://www.google.com/search"><input type=
"hidden" name=
"as_sitesearch" id=
"as_sitesearch" value=
"codeigniter.com/user_guide/" />Search User Guide
<input type=
"text" class=
"input" style=
"width:200px;" name=
"q" id=
"q" size=
"31" maxlength=
"255" value=
"" /> <input type=
"submit" class=
"submit" name=
"sa" value=
"Go" /></form></td>
51 <!-- END BREADCRUMB -->
56 <!-- START CONTENT -->
60 <h1>Directory Helper
</h1>
62 <p>The Directory Helper file contains functions that assist in working with directories.
</p>
65 <h2>Loading this Helper
</h2>
67 <p>This helper is loaded using the following code:
</p>
68 <code>$this-
>load-
>helper('directory');
</code>
70 <p>The following functions are available:
</p>
72 <h2>directory_map('
<var>source directory
</var>')
</h2>
74 <p>This function reads the directory path specified in the first parameter
75 and builds an array representation of it and all its contained files. Example:
</p>
77 <code>$map = directory_map('./mydirectory/');
</code>
79 <p class=
"important"><strong>Note:
</strong> Paths are almost always relative to your main index.php file.
</p>
81 <p>Sub-folders contained within the directory will be mapped as well. If you wish to control the recursion depth,
82 you can do so using the second parameter (integer). A depth of
1 will only map the top level directory:
</p>
84 <code>$map = directory_map('./mydirectory/',
1);
</code>
86 <p>By default, hidden files will not be included in the returned array. To override this behavior,
87 you may set a third parameter to
<var>true
</var> (boolean):
</p>
89 <code>$map = directory_map('./mydirectory/', FALSE, TRUE);
</code>
91 <p>Each folder name will be an array index, while its contained files will be numerically indexed.
92 Here is an example of a typical array:
</p>
96 [libraries] =
> Array
<br />
97 (
<br />
98 [
0] =
> benchmark.html
<br />
99 [
1] =
> config.html
<br />
100 [database] =
> Array
<br />
101 (
<br />
102 [
0] =
> active_record.html
<br />
103 [
1] =
> binds.html
<br />
104 [
2] =
> configuration.html
<br />
105 [
3] =
> connecting.html
<br />
106 [
4] =
> examples.html
<br />
107 [
5] =
> fields.html
<br />
108 [
6] =
> index.html
<br />
109 [
7] =
> queries.html
<br />
110 )
<br />
111 [
2] =
> email.html
<br />
112 [
3] =
> file_uploading.html
<br />
113 [
4] =
> image_lib.html
<br />
114 [
5] =
> input.html
<br />
115 [
6] =
> language.html
<br />
116 [
7] =
> loader.html
<br />
117 [
8] =
> pagination.html
<br />
118 [
9] =
> uri.html
<br />
133 Previous Topic:
<a href=
"date_helper.html">Date Helper
</a>
134 ·
135 <a href=
"#top">Top of Page
</a> ·
136 <a href=
"../index.html">User Guide Home
</a> ·
137 Next Topic:
<a href=
"download_helper.html">Download Helper
</a>
139 <p><a href=
"http://codeigniter.com">CodeIgniter
</a> · Copyright
© 2006 -
2012 · <a href=
"http://ellislab.com/">EllisLab, Inc.
</a></p>