Class: VFtpReply

Source Location: /libraries/vwp/net/protocols/ftp/reply.php

Class Overview [line 29]

VType
   |
   --VObject
      |
      --VFtpReply

Virtual Web Platform - FTP Protocol (RFC-959)

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods

Inherited Variables

Class: VObject

VObject::$_nosave_errors
VObject::$_nosave_original_state

Inherited Constants

Inherited Methods

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::__get()
VObject::__isset()
VObject::__set()
VObject::__toString()
Return object as a string
VObject::__unset()

Class Details

Virtual Web Platform - FTP Protocol (RFC-959)

This class provides the FTP reply interface.

Tags:

[ Top ]

Class Variables

$data =  null

[line 51]

Tags:

  • var - Data buffer
  • access - protected

Type: mixed

Overrides:

[ Top ]

$reply = array()

[line 37]

Tags:

  • var - Reply data
  • access - protected

Type: array

Overrides:

[ Top ]

$reply_code =  null

[line 44]

Tags:

  • var - Reply code
  • access - protected

Type: integer

Overrides:

[ Top ]

Class Methods

getData

mixed getData( )

[line 95]

Get data

Tags:

  • return - Reply data
  • access - public

Parameters:

[ Top ]

getPathInfo

array getPathInfo( )

[line 195]

Get path info 

 Path info will be an empty array if no path response was received.
 Otherwise the path info array has 2 elements:

  pathinfo[0] : Path
  pathinfo[1] : Comments

Tags:

  • return - Path info
  • access - public

Parameters:

[ Top ]

getReplyCode

integer getReplyCode( )

[line 138]

Get reply code

Tags:

  • return - Reply code
  • access - public

Parameters:

[ Top ]

getReplyLevel

integer getReplyLevel( )

[line 156]

Get reply level 

  Reply codes consist of a 3 digit number.
  The first digit is used to determine the reply level.
  If the first digit is less than 3 the operation was successful.

Tags:

  • return - Returns -1 on success, 3 to 5 on warning or error
  • access - public

Parameters:

[ Top ]

setData

void setData( mixed $data)

[line 84]

Set data

Tags:

  • access - public

Parameters:

  • mixed $data - Reply data

[ Top ]

toString

string toString( )

[line 243]

Get text reply

Tags:

  • return - Reply text
  • access - public

Overrides VObject::toString() (Convert object to string)

Parameters:

[ Top ]

value

array value( )

[line 231]

Get reply messages

Tags:

  • return - Reply messages
  • access - public

Parameters:

[ Top ]

write

array write( string $msg)

[line 117]

Write one FTP reply line to message buffer 

  A message is an array consists of 3 elements

  message[0] : Reply code
  message[1] : Reply type
  message[2] : Reply text

Tags:

  • return - Message
  • access - public

Parameters:

  • string $msg - One line of the FTP servers reply

[ Top ]

Class Constants

Documentation generated on Sun, 06 Mar 2011 02:22:17 -0600 by phpDocumentor 1.4.3