diff options
Diffstat (limited to 'user_guide/helpers/file_helper.html')
| -rw-r--r-- | user_guide/helpers/file_helper.html | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/user_guide/helpers/file_helper.html b/user_guide/helpers/file_helper.html new file mode 100644 index 000000000..c6b049b27 --- /dev/null +++ b/user_guide/helpers/file_helper.html @@ -0,0 +1,144 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+
+<title>Code Igniter User Guide</title>
+
+<style type='text/css' media='all'>@import url('../userguide.css');</style>
+<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
+
+<script type="text/javascript" src="../scripts/nav.js"></script>
+<script type="text/javascript" src="../scripts/prototype.lite.js"></script>
+<script type="text/javascript" src="../scripts/moo.fx.js"></script>
+<script type="text/javascript">
+window.onload = function() {
+ myHeight = new fx.Height('nav', {duration: 400});
+ myHeight.hide();
+}
+</script>
+
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta http-equiv='expires' content='-1' />
+<meta http-equiv= 'pragma' content='no-cache' />
+<meta name='robots' content='all' />
+<meta name='author' content='Rick Ellis' />
+<meta name='description' content='Code Igniter User Guide' />
+
+</head>
+<body>
+
+<!-- START NAVIGATION -->
+<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
+<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>
+<div id="masthead">
+<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
+<tr>
+<td><h1>Code Igniter User Guide Version 1.4.0</h1></td>
+<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td>
+</tr>
+</table>
+</div>
+<!-- END NAVIGATION -->
+
+
+<!-- START BREADCRUMB -->
+<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
+<tr>
+<td id="breadcrumb">
+<a href="http://www.codeigniter.com/">Code Igniter Home</a> ›
+<a href="../index.html">User Guide Home</a> ›
+File Helper
+</td>
+<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
+</tr>
+</table>
+<!-- END BREADCRUMB -->
+
+<br clear="all" />
+
+
+<!-- START CONTENT -->
+<div id="content">
+
+
+<h1>File Helper</h1>
+
+<p>The File Helper file contains functions that assist in working with files.</p>
+
+
+<h2>Loading this Helper</h2>
+
+<p>This helper is loaded using the following code:</p>
+<code>$this->load->helper('file');</code>
+
+<p>The following functions are available:</p>
+
+<h2>read_file('<var>path</var>')</h2>
+
+<p>Returns the data contained in the file specified in the path. Example:</p>
+
+<code>$string = read_file('./path/to/file.php');</code>
+
+<p>The path can be a relative or full server path. Returns FALSE (boolean) on failure.</p>
+
+<p class="important"><strong>Note:</strong> The path is relative to your main site index.php file, NOT your controller or view files.
+Code Igniter uses a front controller so paths are always relative to the main site index.</p>
+
+<p>If you server is running an open_basedir restriction this function
+might not work if you are trying to access a file above the calling script.</p>
+
+<h2>write_file('<var>path</var>', <kbd>$data</kbd>)</h2>
+
+<p>Writes data to the file specified in the path. If the file does not exist the function will create it. Example:</p>
+
+<code>
+$data = 'Some file data';<br />
+<br />
+if ( ! write_file('./path/to/file.php', $data))<br />
+{<br />
+ echo 'Unable to write the file';<br />
+}<br />
+else<br />
+{<br />
+ echo 'File written!';<br />
+}</code>
+
+<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.).
+If the file does not already exist, the directory containing it must be writable.</p>
+
+<p class="important"><strong>Note:</strong> The path is relative to your main site index.php file, NOT your controller or view files.
+Code Igniter uses a front controller so paths are always relative to the main site index.</p>
+
+
+
+<h2>delete_files('<var>path</var>')</h2>
+
+<p>Deletes ALL files contained in the supplied path. Example:</p>
+<code>delete_files('/path/to/directory/');</code>
+
+<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>
+
+<code>delete_files('/path/to/directory/', TRUE);</code>
+
+<p class="important"><strong>Note:</strong> The files must be writable or owned by the system in order to be deleted.</p>
+
+
+
+
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p>
+Previous Topic: <a href="directory_helper.html">Directory Helper</a>
+ ·
+<a href="#top">Top of Page</a> ·
+<a href="../index.html">User Guide Home</a> ·
+Next Topic: <a href="form_helper.html">Form Helper</a>
+<p>
+<p><a href="http://www.codeigniter.com">Code Igniter</a> · Copyright © 2006 · <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file |