$instances
$instances : array
SFTP instances
Rather than re-create the connection we re-use instances if possible
SFTP Stream Wrapper
_parse_path(string $path) : string
Path Parser
Extract a path from a URI and actually connect to an SSH server if appropriate
If "notification" is set as a context parameter the message code for successful login is NET_SSH2_MSG_USERAUTH_SUCCESS. For a failed login it's NET_SSH2_MSG_USERAUTH_FAILURE.
| string | $path |
_stream_eof() : boolean
Tests for end-of-file on a file pointer
In my testing there are four classes functions that normally effect the pointer: fseek, fputs / fwrite, fgets / fread and ftruncate.
Only fgets / fread, however, results in feof() returning true. do fputs($fp, 'aaa') on a blank file and feof() will return false. do fread($fp, 1) and feof() will then return true. do fseek($fp, 10) on ablank file and feof() will return false. do fread($fp, 1) and feof() will then return true.
_rename(string $path_from, string $path_to) : boolean
Renames a file or directory
Attempts to rename oldname to newname, moving it between directories if necessary. If newname exists, it will be overwritten. This is a departure from what \phpseclib\Net\SFTP does.
| string | $path_from | |
| string | $path_to |
_dir_opendir(string $path, integer $options) : boolean
Open directory handle
The only $options is "whether or not to enforce safe_mode (0x04)". Since safe mode was deprecated in 5.3 and removed in 5.4 I'm just going to ignore it.
Also, nlist() is the best that this function is realistically going to be able to do. When an SFTP client sends a SSH_FXP_READDIR packet you don't generally get info on just one file but on multiple files. Quoting the SFTP specs:
The SSH_FXP_NAME response has the following format:
uint32 id
uint32 count
repeats count times:
string filename
string longname
ATTRS attrs| string | $path | |
| integer | $options |
_rmdir(string $path, integer $options) : boolean
Removes a directory
Only valid $options is STREAM_MKDIR_RECURSIVE per http://php.net/streamwrapper.rmdir, however, http://php.net/rmdir does not have a $recursive parameter as mkdir() does so I don't know how STREAM_MKDIR_RECURSIVE is supposed to be set. Also, when I try it out with rmdir() I get 8 as $options. What does 8 correspond to?
| string | $path | |
| integer | $options |
_stream_flush() : boolean
Flushes the output
See http://php.net/fflush. Always returns true because \phpseclib\Net\SFTP doesn't cache stuff before writing
_url_stat(string $path, integer $flags) : mixed
Retrieve information about a file
Ignores the STREAM_URL_STAT_QUIET flag because the entirety of \phpseclib\Net\SFTP\Stream is quiet by default might be worthwhile to reconstruct bits 12-16 (ie. the file type) if mode doesn't have them but we'll cross that bridge when and if it's reached
| string | $path | |
| integer | $flags |
_stream_set_option(integer $option, integer $arg1, integer $arg2) : boolean
Change stream options
STREAM_OPTION_WRITE_BUFFER isn't supported for the same reason stream_flush isn't. The other two aren't supported because of limitations in \phpseclib\Net\SFTP.
| integer | $option | |
| integer | $arg1 | |
| integer | $arg2 |
__call( $name, $arguments) : mixed
__call Magic Method
When you're utilizing an SFTP stream you're not calling the methods in this class directly - PHP is calling them for you. Which kinda begs the question... what methods is PHP calling and what parameters is it passing to them? This function lets you figure that out.
If NET_SFTP_STREAM_LOGGING is defined all calls will be output on the screen and then (regardless of whether or not NET_SFTP_STREAM_LOGGING is enabled) the parameters will be passed through to the appropriate method.
| $name | ||
| $arguments |