Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / db60d240226468b19d656c4ba026bc992e4c3034 / . / user_guide / helpers / directory_helper.html
blob: 2086fe1f390ee593a4c3ae66f95ce2a3ba825811 [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]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">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>Directory Helper : CodeIgniter User Guide</title>
7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
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>
15
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' />
21
22</head>
23<body>
24
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>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Pascal Kriete1f622292011-04-07 12:06:51 -0400[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40
41<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
42<tr>
43<td id="breadcrumb">
44<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
45<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
46Directory Helper
47</td>
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&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
49</tr>
50</table>
51<!-- END BREADCRUMB -->
52
53<br clear="all" />
54
55
56<!-- START CONTENT -->
57<div id="content">
58
59
60<h1>Directory Helper</h1>
61
62<p>The Directory Helper file contains functions that assist in working with directories.</p>
63
64
65<h2>Loading this Helper</h2>
66
67<p>This helper is loaded using the following code:</p>
68<code>$this->load->helper('directory');</code>
69
70<p>The following functions are available:</p>
71
72<h2>directory_map('<var>source directory</var>')</h2>
73
74<p>This function reads the directory path specified in the first parameter
75and builds an array representation of it and all its contained files. Example:</p>
76
77<code>$map = directory_map('./mydirectory/');</code>
78
79<p class="important"><strong>Note:</strong> Paths are almost always relative to your main index.php file.</p>
80
Razican114ab092011-04-25 17:26:45 +0200[diff] [blame]81<p>Sub-folders contained within the directory will be mapped as well. If you wish to control the recursion depth,
Pascal Kriete98a447a2010-01-07 18:14:28 +0000[diff] [blame]82you can do so using the second parameter (integer). A depth of 1 will only map the top level directory:</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]83
Pascal Kriete98a447a2010-01-07 18:14:28 +0000[diff] [blame]84<code>$map = directory_map('./mydirectory/', 1);</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]85
Razican114ab092011-04-25 17:26:45 +0200[diff] [blame]86<p>By default, hidden files will not be included in the returned array. To override this behavior,
Robin Sowell96dafa82009-05-26 21:45:54 +0000[diff] [blame]87you may set a third parameter to <var>true</var> (boolean):</p>
88
89<code>$map = directory_map('./mydirectory/', FALSE, TRUE);</code>
90
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]91<p>Each folder name will be an array index, while its contained files will be numerically indexed.
92Here is an example of a typical array:</p>
93
94<code>Array<br />
95(<br />
96&nbsp;&nbsp;&nbsp;[libraries] => Array<br />
97&nbsp;&nbsp;&nbsp;(<br />
98&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[0] => benchmark.html<br />
99&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[1] => config.html<br />
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[database] => Array<br />
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(<br />
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[0] => active_record.html<br />
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[1] => binds.html<br />
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[2] => configuration.html<br />
105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[3] => connecting.html<br />
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[4] => examples.html<br />
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[5] => fields.html<br />
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[6] => index.html<br />
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[7] => queries.html<br />
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;)<br />
111&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[2] => email.html<br />
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[3] => file_uploading.html<br />
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[4] => image_lib.html<br />
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[5] => input.html<br />
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[6] => language.html<br />
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[7] => loader.html<br />
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[8] => pagination.html<br />
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[9] => uri.html<br />
119)</code>
120
121
122
123
124
125
126
127</div>
128<!-- END CONTENT -->
129
130
131<div id="footer">
132<p>
133Previous Topic:&nbsp;&nbsp;<a href="date_helper.html">Date Helper</a>
134&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
135<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
136<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
137Next Topic:&nbsp;&nbsp;<a href="download_helper.html">Download Helper</a>
138</p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]139<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]140</div>
141
142</body>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]143</html>