Changeset 932 for trunk/system/libraries/Ftp.php

Timestamp:

11/01/2007 03:14:45 AM (13 months ago)

Author:

PugFish

Message:

Englishised some descriptions
Converted Validation to new comments

Files:

• trunk/system/libraries/Ftp.php (modified) (18 diffs)

trunk/system/libraries/Ftp.php

@@ -20 +20 @@
         /*
          * Method: __construct
-         *  Sets Preferences. Can be passed an array of config values
+         *  Sets Preferences.
+         *
+         * Parameters:
+         *  config - custom configuration
          */
         public function __construct($config = array())
@@ -34 +37 @@
         /*
          * Method: initialize
-         *  Initialize preferences
-         *
-         * Parameters:
-         *  config - config preferences
+         *  Initialize preferences.
+         *
+         * Parameters:
+         *  config - custom configuration
          */
         public function initialize($config = array())
@@ -55 +58 @@
         /*
          * Method: connect
-         *  Connect to the FTP
+         *  Connect to the FTP.
          *
          * Parameters:
@@ -99 +102 @@
         /*
          * Method: login
-         *  Login to the FTP
+         *  Login to the FTP.
          *
          * Returns:
@@ -111 +114 @@
         /*
          * Method: is_conn
-         *  Validates the connection ID
+         *  Validates the connection ID.
          *
          * Returns:
@@ -168 +171 @@
         /*
          * Method: mkdir
-         *  Create a directory
+         *  Create a directory.
          *
          * Parameters:
@@ -204 +207 @@
         /*
          * Method: upload
-         *  Upload a file to the server
+         *  Upload a file to the server.
          *
          * Parameters:
@@ -258 +261 @@
         /*
          * Method: rename
-         *  Rename (or move) a file
+         *  Rename (or move) a file.
          *
          * Parameters:
@@ -291 +294 @@
         /*
          * Method: move
-         *  Move a file
+         *  Move a file.
          *
          * Parameters:
@@ -307 +310 @@
         /*
          * Method: delete_file
-         *  Delete a file
+         *  Delete a file.
          *
          * Parameters:
@@ -336 +339 @@
         /*
          * Method: delete_dir
-         *  Delete a folder and recursively delete everything (including sub-folders) contained within it
+         *  Delete a folder and recursively delete everything (including sub-folders) contained within it.
          *
          * Parameters:
@@ -383 +386 @@
         /*
          * Method: chmod
-         *  Set file permissions
+         *  Set file permissions.
          *
          * Parameters:
@@ -423 +426 @@
         /*
          * Method: list_files
-         *  FTP List files in the specified directory
+         *  FTP List files in the specified directory.
          *
          * Parameters:
@@ -447 +450 @@
          *  This function recursively reads a 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
+         *  of the original file path will be recreated on the server.
          *
          * Parameters:
@@ -496 +499 @@
         /*
          * Method: get_extension
-         *  Extract the file extension
+         *  Extract the file extension.
          *
          * Parameters:
@@ -517 +520 @@
         /*
          * Method: set_type
-         *  Returns the transfer mode for a file extension (ascii or binary)
+         *  Returns the transfer mode for a file extension (ascii or binary).
          *
          * Parameters:
@@ -549 +552 @@
         /*
          * Method: close
-         *  Close the connection
+         *  Close the connection.
          *
          * Returns:
@@ -564 +567 @@
         /*
          * Method: error
-         *  Display error message
+         *  Display error message.
          *
          * Parameters: