Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / d6c69981ba89e52bec1240307b419806503e1283 / . / user_guide / helpers / file_helper.html
blob: e1205f99e96506e7128cf1821e28fb6706fc15de [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]3<head>
4
Derek Allard8039d4c2008-05-31 02:47:56 +0000[diff] [blame]5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Derek Jonesfd93d222008-05-06 15:18:50 +0000[diff] [blame]6<title>File Helper : CodeIgniter User Guide</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]11<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]13<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]15
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]21</head>
22<body>
23
24<!-- START NAVIGATION -->
25<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
26<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
27<div id="masthead">
28<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
29<tr>
Derek Jones6b7b11f2008-05-06 16:07:27 +0000[diff] [blame]30<td><h1>CodeIgniter User Guide Version 1.6.2</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]31<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]32</tr>
33</table>
34</div>
35<!-- END NAVIGATION -->
36
37
38<!-- START BREADCRUMB -->
39<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
40<tr>
41<td id="breadcrumb">
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]42<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]43<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
44File Helper
45</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]46<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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]47</tr>
48</table>
49<!-- END BREADCRUMB -->
50
51<br clear="all" />
52
53
54<!-- START CONTENT -->
55<div id="content">
56
57
58<h1>File Helper</h1>
59
60<p>The File Helper file contains functions that assist in working with files.</p>
61
62
63<h2>Loading this Helper</h2>
64
65<p>This helper is loaded using the following code:</p>
66<code>$this->load->helper('file');</code>
67
68<p>The following functions are available:</p>
69
70<h2>read_file('<var>path</var>')</h2>
71
72<p>Returns the data contained in the file specified in the path. Example:</p>
73
74<code>$string = read_file('./path/to/file.php');</code>
75
76<p>The path can be a relative or full server path. Returns FALSE (boolean) on failure.</p>
77
78<p class="important"><strong>Note:</strong> The path is relative to your main site index.php file, NOT your controller or view files.
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]79CodeIgniter uses a front controller so paths are always relative to the main site index.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]80
Derek Allard4e387c32007-12-22 16:41:29 +0000[diff] [blame]81<p>If your server is running an open_basedir restriction this function
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]82might not work if you are trying to access a file above the calling script.</p>
83
84<h2>write_file('<var>path</var>', <kbd>$data</kbd>)</h2>
85
86<p>Writes data to the file specified in the path. If the file does not exist the function will create it. Example:</p>
87
88<code>
89$data = 'Some file data';<br />
90<br />
Derek Jones0b59f272008-05-13 04:22:33 +0000[diff] [blame]91if ( ! write_file('./path/to/file.php', $data))<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]92{<br />
93&nbsp;&nbsp;&nbsp;&nbsp; echo 'Unable to write the file';<br />
94}<br />
95else<br />
96{<br />
97&nbsp;&nbsp;&nbsp;&nbsp; echo 'File written!';<br />
98}</code>
99
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]100<p>You can optionally set the write mode via the third parameter:</p>
adminb64b0be2006-09-02 17:19:54 +0000[diff] [blame]101
102<code>write_file('./path/to/file.php', $data, <var>'r+'</var>);</code>
103
104<p>The default mode is <kbd>wb</kbd>. Please see the <a href="http://php.net/fopen">PHP user guide</a> for mode options.</p>
105
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]106<p>Note: In order for this function to write data to a file its file permissions must be set such that it is writable (666, 777, etc.).
107If the file does not already exist, the directory containing it must be writable.</p>
108
109<p class="important"><strong>Note:</strong> The path is relative to your main site index.php file, NOT your controller or view files.
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]110CodeIgniter uses a front controller so paths are always relative to the main site index.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]111
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]112<h2>delete_files('<var>path</var>')</h2>
113
114<p>Deletes ALL files contained in the supplied path. Example:</p>
Derek Allard4ae32252007-05-04 11:25:13 +0000[diff] [blame]115<code>delete_files('./path/to/directory/');</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]116
117<p>If the second parameter is set to <kbd>true</kbd>, any directories contained within the supplied root path will be deleted as well. Example:</p>
118
Derek Allard4ae32252007-05-04 11:25:13 +0000[diff] [blame]119<code>delete_files('./path/to/directory/', TRUE);</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]120
121<p class="important"><strong>Note:</strong> The files must be writable or owned by the system in order to be deleted.</p>
122
admine85c05d2006-10-23 20:18:34 +0000[diff] [blame]123<h2>get_filenames('<var>path/to/directory/</var>')</h2>
124
125<p>Takes a server path as input and returns an array containing the names of all files contained within it. The file path
126can optionally be added to the file names by setting the second parameter to TRUE.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]127
Derek Allard73274992008-05-05 16:39:18 +0000[diff] [blame]128<h2>get_dir_file_info('<var>path/to/directory/</var>')</h2>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]129
Derek Allard73274992008-05-05 16:39:18 +0000[diff] [blame]130<p>Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions. Any sub-folders contained within the specified path are read as well.</p>
131
132<h2>get_file_info('<var>path/to/file</var>', <kbd>$file_information</kbd>)</h2>
133
134<p>Given a file and path, returns the name, path, size, date modified. Second parameter allows you to explicitly declare what information you want returned; options are: name, server_path, size, date, readable, writable, executable, fileperms. Returns FALSE if the file cannot be found.</p>
135
136<p class="important"><strong>Note:</strong> The &quot;writable&quot; uses the PHP function is_writable() which is known to have issues on the IIS webserver. Consider using fileperms instead, which returns information from PHP's fileperms() function.</p>
Derek Allardee0a7f02008-05-08 13:59:27 +0000[diff] [blame]137<h2>get_mime_by_extension('<var>file</var>')</h2>
Derek Allard73274992008-05-05 16:39:18 +0000[diff] [blame]138
139<p>Translates a file extension into a mime type based on config/mimes.php. Returns FALSE if it can't determine the type, or open the mime config file.</p>
Derek Allardee0a7f02008-05-08 13:59:27 +0000[diff] [blame]140<p>
141<code>$file = &quot;somefile.png&quot;;<br />
142echo $file . ' is has a mime type of ' . get_mime_by_extension($file);</code>
143</p>
144<p class="critical"><strong>Note:</strong> This is not an accurate way of determining file mime types, and is here strictly as a convenience. It should not be used for security.</p>
Derek Jones94a21822008-05-08 15:00:28 +0000[diff] [blame]145
146<h2>symbolic_permissions(<kbd>$perms</kbd>)</h2>
147
148<p>Takes numeric permissions (such as is returned by <kbd>fileperms()</kbd> and returns standard symbolic notation of file permissions.</p>
149
150<code>echo symbolic_permissions(fileperms('./index.php'));<br />
151<br />
152// -rw-r--r--</code>
153
154<h2>octal_permissions(<kbd>$perms</kbd>)</h2>
155
156<p>Takes numeric permissions (such as is returned by <kbd>fileperms()</kbd> and returns a three character octal notation of file permissions.</p>
157
158<code>echo octal_permissions(fileperms('./index.php'));<br />
159<br />
160// 644</code>
161
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]162</div>
Derek Jones94a21822008-05-08 15:00:28 +0000[diff] [blame]163
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]164<!-- END CONTENT -->
165
166
167<div id="footer">
168<p>
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]169Previous Topic:&nbsp;&nbsp;<a href="email_helper.html">Email Helper</a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]170&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
171<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
172<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
Derek Allard5a34f042008-01-19 19:41:54 +0000[diff] [blame]173Next Topic:&nbsp;&nbsp;<a href="form_helper.html">Form Helper</a></p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]174<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]175</div>
176
177</body>
178</html>