Inherited Methods
Class: VFtp
- VFtp::chmod()
- FTP (CHMOD)
- VFtp::cwd()
- FTP (CWD)
- VFtp::dele()
- FTP (DELE)
- VFtp::doList()
- FTP (LIST)
- VFtp::doType()
- FTP (TYPE)
- VFtp::getReply()
- Get reply
- VFtp::mkd()
- FTP (MKD)
- VFtp::pass()
- FTP (PASS)
- VFtp::pasv()
- FTP (PASV)
- VFtp::port()
- FTP (PORT)
- VFtp::pwd()
- FTP (PWD)
- VFtp::quit()
- FTP (QUIT)
- VFtp::retr()
- FTP (RETR)
- VFtp::rmd()
- FTP (RMD)
- VFtp::rnfr()
- FTP (RNFR)
- VFtp::rnto()
- FTP (RNTO)
- VFtp::sendCommand()
- Send raw FTP command
- VFtp::stor()
- FTP (STOR)
- VFtp::user()
- FTP (USER)
Class: VTelnet
- VTelnet::__construct()
- Class constructor
- VTelnet::isError()
- Test if a value is an error
- VTelnet::isWarning()
- Test if a value is a warning or an error
- VTelnet::raiseError()
- Generate an error
- VTelnet::raiseWarning()
- Generate a warning
- VTelnet::readLine()
- Read line of input
Class: VSocket
- VSocket::__construct()
- Class constructor
- VSocket::accept()
- Accept an incomming connection
- VSocket::bind()
- Bind socket
- VSocket::close()
- Close socket
- VSocket::connect()
- Connect to remote socket
- VSocket::disconnect()
- Disconnect
- VSocket::doSelect()
- Monitor sockets for selected change
- VSocket::getDomain()
- Get socket domain
- VSocket::getOption()
- Get a socket option
- VSocket::getPeerName()
- Get peer connection info
- VSocket::getProtocol()
- Get protocol of socket
- VSocket::getProtocolName()
- Get protocol name
- VSocket::getSockName()
- Get Socket connection info
- VSocket::getSupportedProtocols()
- Get list of supported protocols
- VSocket::getType()
- Get socket type
- VSocket::listen()
- Listen for connection
- VSocket::raiseError()
- Generate a socket error
- VSocket::read()
- Read from socket
- VSocket::recv()
- Receive data from socket
- VSocket::recvFrom()
- Receive data from socket even if not connection oriented
- VSocket::send()
- Send data from socket
- VSocket::sendTo()
- Send data from socket even if not connection oriented
- VSocket::setBlock()
- Set socket blocking
- VSocket::setDomain()
- Set the socket domain
- VSocket::setOption()
- Set a socket option
- VSocket::setProtocol()
- Set protocol
- VSocket::setType()
- Set socket type
- VSocket::shutdown()
- Shutdown socket
- VSocket::write()
- Write to socket
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__toString()
- Return object as a string
Class Details
Virtual Web Platform - FTP Client
This class provides the default FTP Client.
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$banner = null
[line 50]
Tags:
- var - FTP Banner reply
- access - public
Type: object
Overrides:
[ Top ]
$base = null
[line 94]
Tags:
- var - Remote base path
- access - protected
Type: string
Overrides:
[ Top ]
$connected = false
[line 71]
Tags:
- var - Connected
- access - protected
Type: boolean
Overrides:
[ Top ]
$passive = false
[line 78]
Tags:
- var - Passive mode
- access - protected
Type: boolean
Overrides:
[ Top ]
$password = null
[line 64]
Tags:
- var - Password
- access - protected
Type: string
Overrides:
[ Top ]
$relay = false
[line 87]
Reserved for future use (ftp to ftp)
Tags:
- var - Relay mode
- access - protected
Type: boolean
Overrides:
[ Top ]
$username = null
[line 57]
Tags:
- var - Username
- access - protected
Type: string
Overrides:
[ Top ]
Class Methods
chmod
object FTP chmod(
string
$file, integer
$permission)
[line 286]
FTP (CHMOD) Change file or directory permissions
Tags:
- return - Reply on success, error or warning on failure
- access - public
Overrides VFtp::chmod() (FTP (CHMOD))
Parameters:
- string $file - File to change permissions on
- integer $permission - Permissions
[ Top ]
cleanFullPath
string cleanFullPath(
string
$path)
[line 588]
Convert remote path into a virtual path
Tags:
- return - Virtual path
Parameters:
- string $path - Remote path
[ Top ]
connect
FTP connect(
string
$host, [integer
$port = 21])
[line 436]
Connect to FTP Server
Tags:
- return - login Reply on success, error or warning on failure
- access - public
Overrides VSocket::connect() (Connect to remote socket)
Parameters:
- string $host - Server network address
- integer $port - Server network port
[ Top ]
cwd
object FTP cwd(
string
$path)
[line 214]
FTP (CWD) Change current directory
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::cwd() (FTP (CWD))
Parameters:
- string $path - Directory to change to
[ Top ]
dele
object FTP dele(
string
$file)
[line 270]
FTP (DELE) Delete file
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::dele() (FTP (DELE))
Parameters:
- string $file - File to delete
[ Top ]
disconnect
true|object True disconnect(
)
[line 461]
Disconnect from FTP server
Tags:
- return - or FTP reply on success, error or warning on failure
- access - public
Overrides VSocket::disconnect() (Disconnect)
Parameters:
[ Top ]
doList
object FTP doList(
[string
$path = null])
[line 300]
FTP (LIST) List files in a directory
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::doList() (FTP (LIST))
Parameters:
- string $path - Directory path
[ Top ]
getFullPath
string getFullPath(
string
$path)
[line 612]
Convert virtual path into a remote path
Tags:
- return - Remote path
- access - public
Parameters:
- string $path - Virtual path
[ Top ]
getInstance
object Requested &getInstance(
[string
$class = null])
[line 485]
Get a FTP Client object
Object types: vfolder : FTP Folder default : FTP Client
Tags:
- return - FTP Object
- access - public
Parameters:
- string $class - Object type
[ Top ]
login
object FTP login(
array
$credentials)
[line 651]
Login to FTP server
Credentials support two keys username : Login username password : Login password
Tags:
- return - Reply on success, error or warning otherwise
- access - public
Parameters:
- array $credentials - Credentials
[ Top ]
mkd
object FTP mkd(
string
$path)
[line 200]
FTP (MKD) Create directory
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::mkd() (FTP (MKD))
Parameters:
- string $path - Directory to create
[ Top ]
retr
object FTP retr(
string
$filename)
[line 341]
FTP (RETR) Get remote file
Tags:
- return - Reply on success, error or warning on failure
- access - public
Overrides VFtp::retr() (FTP (RETR))
Parameters:
- string $filename - Filename
[ Top ]
rmd
object FTP rmd(
string
$path)
[line 256]
FTP (RMD) Delete directory
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::rmd() (FTP (RMD))
Parameters:
- string $path - Directory to delete
[ Top ]
rnfr
object FTP rnfr(
string
$path)
[line 228]
FTP (RNFR) Rename from
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::rnfr() (FTP (RNFR))
Parameters:
- string $path - Source directory or filename
[ Top ]
rnto
object FTP rnto(
string
$path)
[line 242]
FTP (RNTO) Rename to
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::rnto() (FTP (RNTO))
Parameters:
- string $path - Destination directory or filename
[ Top ]
setBase
void setBase(
string
$basePath)
[line 550]
Set remote base path
Tags:
- access - public
Parameters:
- string $basePath - Remote base path
[ Top ]
setPassive
void setPassive(
[boolean
$passive = true])
[line 562]
Set passive mode
Tags:
- access - public
Parameters:
- boolean $passive - Passive mode
[ Top ]
setPassword
void setPassword(
string
$password)
[line 537]
Set password
Tags:
- access - public
Parameters:
- string $password - Password
[ Top ]
setRelay
void setRelay(
[boolean
$relay = true])
[line 576]
Set relay mode
Reserved for future use
Tags:
- access - public
Parameters:
- boolean $relay - Relay mode
[ Top ]
setUsername
void setUsername(
string
$username)
[line 525]
Set username
Tags:
- access - public
Parameters:
- string $username - username
[ Top ]
stor
object FTP stor(
string
$file, [string
$buffer = ''], [string
$type = "I"])
[line 390]
FTP (STOR) Upload file to remote FTP server
Supported transfer types: "A" : Ascii "E" : EBCDIC "I" : Binary (Image)
Tags:
- return - Reply on success, error or warning on failure
Overrides VFtp::stor() (FTP (STOR))
Parameters:
- string $file - Remote filename
- string $buffer - File data
- string $type - Transfer type
[ Top ]
_getDataLine
object Data &_getDataLine(
string
$type)
[line 113]
Create a data line
Supported data line types: A : Ascii E : EBCDIC I : Binary (Image)
Tags:
- return - line on success, error or warning otherwise
- access - protected
Parameters:
- string $type - Data line type
[ Top ]