From 7ec3650749b2c4baf1600bf09fdf3e41f06d87d1 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Mon, 22 Mar 2010 11:11:30 -0500 Subject: added documentation for philsturgeon's submission of download() for the FTP library --- user_guide/changelog.html | 3 ++- user_guide/libraries/ftp.html | 13 +++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) (limited to 'user_guide') diff --git a/user_guide/changelog.html b/user_guide/changelog.html index 21e1bf142..8d9653aa6 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -89,7 +89,8 @@ Hg Tag:

  • Added HTTP headers and Config information to the Profiler output.
  • Added Chrome and Flock to the list of detectable browsers by browser() in the User Agent Class.
  • The Unit Test Class now has an optional "notes" field available to it, and allows for discrete display of test result items using $this->unit->set_test_items().
    • -
  • Added a $xss_clean class variable to the XMLRPC library, enabling control over the use of the Security library's xss_clean() method.
    • +
  • Added a $xss_clean class variable to the XMLRPC library, enabling control over the use of the Security library's xss_clean() method.
    • +
  • Added a download() method to the FTP library
  • Database diff --git a/user_guide/libraries/ftp.html b/user_guide/libraries/ftp.html index 10acdcdab..b5194e8ad 100644 --- a/user_guide/libraries/ftp.html +++ b/user_guide/libraries/ftp.html @@ -188,6 +188,19 @@ Example:

    Permissions are available if you are running PHP 5 and can be passed as an octal value in the fourth parameter.

    +

    $this->ftp->download()

    + +

    Downloads a file from your server. You must supply the remote path and the local path, and you can optionally set the mode. +Example:

    + +$this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii'); + +

    Mode options are:  ascii, binary, and auto (the default). If +auto is used it will base the mode on the file extension of the source file.

    + +

    Returns FALSE if the download does not execute successfully (including if PHP does not have permission to write the local file)

    + +

    $this->ftp->rename()

    Permits you to rename a file. Supply the source file name/path and the new file name/path.

    -- cgit v1.2.3-24-g4f1b