summaryrefslogtreecommitdiffstats
path: root/user_guide/libraries/ftp.html
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide/libraries/ftp.html')
-rw-r--r--user_guide/libraries/ftp.html38
1 files changed, 19 insertions, 19 deletions
diff --git a/user_guide/libraries/ftp.html b/user_guide/libraries/ftp.html
index 1c1ad73e9..c318bc15a 100644
--- a/user_guide/libraries/ftp.html
+++ b/user_guide/libraries/ftp.html
@@ -28,7 +28,7 @@
<div id="masthead">
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
<tr>
-<td><h1>CodeIgniter User Guide Version 2.0.1</h1></td>
+<td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
</tr>
</table>
@@ -59,7 +59,7 @@ FTP Class
<h1>FTP Class</h1>
<p>CodeIgniter's FTP Class permits files to be transfered to a remote server. Remote files can also be moved, renamed,
-and deleted. The FTP class also includes a "mirroring" function that permits an entire local directory to be recreated remotely via FTP.</p>
+and deleted. The FTP class also includes a "mirroring" function that permits an entire local directory to be recreated remotely via FTP.</p>
<p class="important"><strong>Note:</strong>&nbsp; SFTP and SSL FTP protocols are not supported, only standard FTP.</p>
@@ -74,7 +74,7 @@ and deleted. The FTP class also includes a "mirroring" function that permits an
<h2>Usage Examples</h2>
<p>In this example a connection is opened to the FTP server, and a local file is read and uploaded in ASCII mode. The
-file permissions are set to 755. Note: Setting permissions requires PHP 5.</p>
+file permissions are set to 755. Note: Setting permissions requires PHP 5.</p>
<code>
$this->load->library('ftp');<br />
@@ -157,26 +157,26 @@ $this->ftp->connect($config);<br />
<h3>Setting FTP Preferences in a Config File</h3>
<p>If you prefer you can store your FTP preferences in a config file.
-Simply create a new file called the <var>ftp.php</var>, add the <var>$config</var>
+Simply create a new file called the <var>ftp.php</var>, add the <var>$config</var>
array in that file. Then save the file at <var>config/ftp.php</var> and it will be used automatically.</p>
<h3>Available connection options:</h3>
<ul>
-<li><strong>hostname</strong> - the FTP hostname. Usually something like:&nbsp; <dfn>ftp.example.com</dfn></li>
+<li><strong>hostname</strong> - the FTP hostname. Usually something like:&nbsp; <dfn>ftp.example.com</dfn></li>
<li><strong>username</strong> - the FTP username.</li>
<li><strong>password</strong> - the FTP password.</li>
<li><strong>port</strong> - The port number. Set to <dfn>21</dfn> by default.</li>
<li><strong>debug</strong> - <kbd>TRUE/FALSE</kbd> (boolean). Whether to enable debugging to display error messages.</li>
-<li><strong>passive</strong> - <kbd>TRUE/FALSE</kbd> (boolean). Whether to use passive mode. Passive is set automatically by default.</li>
+<li><strong>passive</strong> - <kbd>TRUE/FALSE</kbd> (boolean). Whether to use passive mode. Passive is set automatically by default.</li>
</ul>
<h2>$this->ftp->upload()</h2>
-<p>Uploads a file to your server. You must supply the local path and the remote path, and you can optionally set the mode and permissions.
+<p>Uploads a file to your server. You must supply the local path and the remote path, and you can optionally set the mode and permissions.
Example:</p>
@@ -190,7 +190,7 @@ Example:</p>
<h2>$this->ftp->download()</h2>
-<p>Downloads a file from your server. You must supply the remote path and the local path, and you can optionally set the mode.
+<p>Downloads a file from your server. You must supply the remote path and the local path, and you can optionally set the mode.
Example:</p>
<code>$this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii');</code>
@@ -202,7 +202,7 @@ Example:</p>
<h2>$this->ftp->rename()</h2>
-<p>Permits you to rename a file. Supply the source file name/path and the new file name/path.</p>
+<p>Permits you to rename a file. Supply the source file name/path and the new file name/path.</p>
<code>
// Renames green.html to blue.html<br />
@@ -210,7 +210,7 @@ $this->ftp->rename('/public_html/foo/green.html', '/public_html/foo/blue.html');
</code>
<h2>$this->ftp->move()</h2>
-<p>Lets you move a file. Supply the source and destination paths:</p>
+<p>Lets you move a file. Supply the source and destination paths:</p>
<code>
// Moves blog.html from "joe" to "fred"<br />
@@ -221,7 +221,7 @@ $this->ftp->move('/public_html/joe/blog.html', '/public_html/fred/blog.html');
<h2>$this->ftp->delete_file()</h2>
-<p>Lets you delete a file. Supply the source path with the file name.</p>
+<p>Lets you delete a file. Supply the source path with the file name.</p>
<code>
$this->ftp->delete_file('/public_html/joe/blog.html');
@@ -229,10 +229,10 @@ $this->ftp->delete_file('/public_html/joe/blog.html');
<h2>$this->ftp->delete_dir()</h2>
-<p>Lets you delete a directory and everything it contains. Supply the source path to the directory with a trailing slash.</p>
+<p>Lets you delete a directory and everything it contains. Supply the source path to the directory with a trailing slash.</p>
-<p class="important"><strong>Important</strong>&nbsp; Be VERY careful with this function. It will recursively delete
-<b>everything</b> within the supplied path, including sub-folders and all files. Make absolutely sure your path is correct.
+<p class="important"><strong>Important</strong>&nbsp; Be VERY careful with this function. It will recursively delete
+<b>everything</b> within the supplied path, including sub-folders and all files. Make absolutely sure your path is correct.
Try using the <kbd>list_files()</kbd> function first to verify that your path is correct.</p>
<code>
@@ -242,7 +242,7 @@ $this->ftp->delete_dir('/public_html/path/to/folder/');
<h2>$this->ftp->list_files()</h2>
-<p>Permits you to retrieve a list of files on your server returned as an <dfn>array</dfn>. You must supply
+<p>Permits you to retrieve a list of files on your server returned as an <dfn>array</dfn>. You must supply
the path to the desired directory.</p>
<code>
@@ -255,7 +255,7 @@ print_r($list);
<h2>$this->ftp->mirror()</h2>
<p>Recursively reads a local folder and everything it contains (including sub-folders) and creates a
-mirror via FTP based on it. Whatever the directory structure of the original file path will be recreated on the server.
+mirror via FTP based on it. Whatever the directory structure of the original file path will be recreated on the server.
You must supply a source path and a destination path:</p>
<code>
@@ -266,7 +266,7 @@ $this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/');
<h2>$this->ftp->mkdir()</h2>
-<p>Lets you create a directory on your server. Supply the path ending in the folder name you wish to create, with a trailing slash.
+<p>Lets you create a directory on your server. Supply the path ending in the folder name you wish to create, with a trailing slash.
Permissions can be set by passed an <kbd>octal</kbd> value in the second parameter (if you are running PHP 5).</p>
<code>
@@ -277,7 +277,7 @@ $this->ftp->mkdir('/public_html/foo/bar/', DIR_WRITE_MODE);
<h2>$this->ftp->chmod()</h2>
-<p>Permits you to set file permissions. Supply the path to the file or folder you wish to alter permissions on:</p>
+<p>Permits you to set file permissions. Supply the path to the file or folder you wish to alter permissions on:</p>
<code>
// Chmod "bar" to 777<br />
@@ -288,7 +288,7 @@ $this->ftp->chmod('/public_html/foo/bar/', DIR_WRITE_MODE);
<h2>$this->ftp->close();</h2>
-<p>Closes the connection to your server. It's recommended that you use this when you are finished uploading.</p>
+<p>Closes the connection to your server. It's recommended that you use this when you are finished uploading.</p>