phpCoreLib2
[ class tree: phpCoreLib2 ] [ index: phpCoreLib2 ] [ all elements ]

Class: DFTPBase

Source Location: /Remote/FTP/DFTPBase.php

Class Overview

DObject
   |
   --DFTPBase

Base FTP Class


Variables

Methods


Child classes:

DFTP
Main FTP Class

Inherited Constants

Inherited Variables

Inherited Methods

Class: DObject

DObject::__construct()
Constructor
DObject::debug()
Debig
DObject::getClassMembers()
Gets member variables of the instance
DObject::getClassMemberType()
Gets class member type
DObject::getClassMethods()
Gets classes of the class
DObject::getClassName()
Gets class name
DObject::PHPSerialize()
Gets serialized string of the class
DObject::trace()
Trace
DObject::__destruct()
Descructor
DObject::__toString()
Returns String equivalent of the object.

Class Details

[line 14]
Base FTP Class



[ Top ]


Class Variables

$errorMsg =  ""

[line 70]

Error Message



Tags:

access:  public

Type:   string


[ Top ]

$hostName =  ""

[line 21]

Host name



Tags:

access:  public

Type:   string


[ Top ]

$hostPort =  21

[line 35]

Host port



Tags:

access:  public

Type:   int


[ Top ]

$hostTimeout =  90

[line 42]

Host timeout



Tags:

access:  public

Type:   int


[ Top ]

$hostUserName =  "anonymous"

[line 49]

Host username



Tags:

access:  public

Type:   string


[ Top ]

$hostUserPass =  "anonymous@email.com"

[line 56]

Host userpass



Tags:

access:  public

Type:   string


[ Top ]

$_connection =  null

[line 63]

FTP Connection



Tags:

access:  protected

Type:   resource


[ Top ]



Class Methods


constructor __construct [line 79]

DFTPBase __construct( [string $hostName = null])

Constructor



Tags:

access:  public


Overridden in child classes as:

DFTP::__construct()
Constructor
DFTPAdvanced::__construct()
Constructor

Overrides DObject::__construct() (Constructor)

Parameters:

string   $hostName  

[ Top ]

destructor __destruct [line 92]

void __destruct( )

Destructor



Tags:

access:  public


Overridden in child classes as:

DFTP::__destruct()
Destructor
DFTPAdvanced::__destruct()
Destructor

Overrides DObject::__destruct() (Descructor)

[ Top ]

method close [line 165]

boolean close( )

Closes the FTP connection



Tags:

access:  public


[ Top ]

method connect [line 115]

boolean connect( [boolean $autoLogin = true])

Connects to FTP server



Tags:

access:  public


Parameters:

boolean   $autoLogin  

[ Top ]

method executeCommand [line 211]

boolean executeCommand( string $command)

Executes command on ftp server



Tags:

access:  public


Parameters:

string   $command  

[ Top ]

method executeSiteCommand [line 230]

boolean executeSiteCommand( string $command)

Executes SITE command on server



Tags:

access:  public


Parameters:

string   $command  

[ Top ]

method getFTPConnection [line 182]

resource &getFTPConnection( )

Gets FTP connection resource



Tags:

access:  public


[ Top ]

method getHostIp [line 266]

string getHostIp( )

Gets host IP



Tags:

access:  public


[ Top ]

method getRemoteFileSize [line 277]

int getRemoteFileSize( string $fileName)

Gets remote file size in bytes



Tags:

access:  public


Parameters:

string   $fileName  

[ Top ]

method getSystemType [line 249]

string getSystemType( )

Gets FTP server type



Tags:

access:  public


[ Top ]

method login [line 140]

boolean login( )

Logs in



Tags:

access:  public


[ Top ]

method setFileDirectoryPermissions [line 289]

boolean setFileDirectoryPermissions( string $permissions, string $fileOrDirectory)

Sets file or directory permissions



Tags:

access:  public


Parameters:

string   $permissions  
string   $fileOrDirectory  

[ Top ]

method setHost [line 103]

void setHost( string $hostName)

Sets host name and IP



Tags:

access:  public


Parameters:

string   $hostName  

[ Top ]

method setPassiveMode [line 193]

boolean setPassiveMode( [boolean $mode = true])

Sets passive mode on/off



Tags:

access:  public


Parameters:

boolean   $mode  

[ Top ]

method _setErrorMsg [line 303]

void _setErrorMsg( string $errorMsg)

Sets error message



Tags:

access:  protected


Parameters:

string   $errorMsg  

[ Top ]


Documentation generated on Sat, 17 Apr 2010 22:05:55 +0300 by phpDocumentor 1.4.3