Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

* Added docs on throwen errors.

git-svn-id: http://svn.php.net/repository/pear/packages/Net_FTP2/trunk@177465 c90b9560-bf6c-de11-be94-00142212c4b1
  • Loading branch information...
commit 25746ac1490bf3c444e7a415b2549577c0bebbc6 1 parent 154e71b
Tobias Schlitt tobyS authored
Showing with 30 additions and 0 deletions.
  1. +30 −0 Net/FTP2/Driver.php
30 Net/FTP2/Driver.php
View
@@ -115,6 +115,7 @@ function _parseURI($uri)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param int $filesize
@@ -151,6 +152,7 @@ function ftp_cdup()
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $directory
@@ -169,6 +171,7 @@ function ftp_chdir($directory)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param int $mode
@@ -188,6 +191,7 @@ function ftp_chmod($mode, $filename)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @return boolean True on success, otherwise false.
@@ -205,6 +209,7 @@ function ftp_close()
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $host The host to connect to.
* @param int $port The port to connect to.
@@ -225,6 +230,7 @@ function ftp_connect($host, $port = 21, $timeout = 90)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $path The path for the file to delete.
* @access public
@@ -243,6 +249,7 @@ function ftp_delete($path)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $command The command to execute.
* @access public
@@ -261,6 +268,7 @@ function ftp_exec($command)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param resource $handle Local file handler to write to.
* @param string $remote_file Path to the remote file to download.
@@ -282,6 +290,7 @@ function ftp_fget($handle, $remote_file, $mode, $resumepos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $remote_file Path to the remote file to upload to.
* @param resource $handle Local file handler to upload.
@@ -303,6 +312,7 @@ function ftp_fput($remote_file, $handle, $mode, $startpos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $local Local file path to write to.
* @param string $remote_file Path to the remote file to download.
@@ -324,6 +334,7 @@ function ftp_get($local_file, $remote_file, $mode, $resumepos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $remote_file Path to the remote file to upload to.
* @param string $local_file Local file to upload.
@@ -345,6 +356,7 @@ function ftp_put($remote_file, $handle, $mode, $startpos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $username The username.
* @param string $password The password.
@@ -364,6 +376,7 @@ function ftp_login($username, $password)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $remote_file Path to the remote file.
* @access public
@@ -382,6 +395,7 @@ function ftp_mdtm($remote_file)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $directory Path for the directory to create.
* @access public
@@ -400,6 +414,7 @@ function ftp_mkdir($directory)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @return int Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
@@ -417,6 +432,7 @@ function ftp_nb_continue()
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param resource $handle Local file handler to write to.
@@ -439,6 +455,7 @@ function ftp_nb_fget($handle, $remote_file, $mode, $resumepos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $remote_file Path to the remote file to upload to.
* @param string $local_file Local file to upload.
@@ -460,6 +477,7 @@ function ftp_nb_fput($remote_file, $handle, $mode, $startpos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $local_file Local file path to write to.
* @param string $remote_file Path to the remote file to download.
@@ -481,6 +499,7 @@ function ftp_nb_get($local_file, $remote_file, $mode, $resumepos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $remote_file Path to the remote file to upload to.
* @param resource $local_file Local file to upload.
@@ -502,6 +521,7 @@ function ftp_nb_put($remote_file, $local_file, $mode, $startpos = null)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param string $directory The directory to list files from.
* @access public
@@ -520,6 +540,7 @@ function ftp_nlist ($directory)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @param bool $pasv True to turn on pasv mode, false to turn off.
* @access public
@@ -538,6 +559,7 @@ function ftp_pasv ($pasv)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @return mixed String the current directory or false on error.
@@ -555,6 +577,7 @@ function ftp_pwd()
* This is one of the functions provided by extFTP, which must not be implemented by a driver since it's an alias to ftp_close('..').
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @return bool True on success, otherwise false.
@@ -572,6 +595,7 @@ function ftp_quit()
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $directory The directory to list files from.
@@ -590,6 +614,7 @@ function ftp_rawlist($directory)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $from The file to rename.
@@ -609,6 +634,7 @@ function ftp_rename($from, $to)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $directory The directory to remove.
@@ -627,6 +653,7 @@ function ftp_rmdir($directory)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $cmd The command to send.
@@ -645,6 +672,7 @@ function ftp_site($cmd)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $remote_file File to determine the size of.
@@ -663,6 +691,7 @@ function ftp_size($remote_file)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @param string $host The host to connect to.
@@ -683,6 +712,7 @@ function ftp_ssl_connect($host, $port = 21, $timeout = 90)
* This is one of the functions provided by extFTP, which should be implemented by a driver.
*
* @abstract
+ * @throws PEAR_Error(NET_FTP2_ERROR_METHODNOTIMPLEMENTED_CODE)
* @since 0.1
* @access public
* @return mixed String, the remote system type, or false on error.
Please sign in to comment.
Something went wrong with that request. Please try again.