Class: FTPUploadApplet

Source Location: /html/components/FTPUploadApplet.class.php

Class Overview

FTPHost
   |
   --FTPUploadApplet

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

Copyright:

Copyright (C) 2006 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Inherited Variables

Class: FTPHost

FTPHost::$is_connected
FTPHost::$name
FTPHost::$password
FTPHost::$port
FTPHost::$user

Inherited Methods

Class: FTPHost

FTPHost::FTPHost(): Constructor
FTPHost::chmod(): Attempts to change the mode of the specified file to that given in mode.
FTPHost::connect(): Opens a connection to the ftp server.
FTPHost::copy(): Copys a given file/directory.
FTPHost::delete(): Deletes a file or a folder. Folders will be delete recursively!
FTPHost::disconnect(): Closes the current connection to the ftp server.
FTPHost::dissolveDir(): To dissolve a directory means that all containing files will be shifted up a level and the directory itself will be removed.
FTPHost::filesize(): Puts out the size of a given file.
FTPHost::file_exists(): Checks whether the given file exists.
FTPHost::getHost(): Returns the hostname.
FTPHost::getName(): Returns the hostname. This method is an alias of the method getHost().
FTPHost::getPassword(): Returns the given password which should be usedto connect to the host.
FTPHost::getPort(): Returns the specified port to use to connect to the host.
FTPHost::getUser(): Returns the specified user who should connect with to the host.
FTPHost::is_dir(): Checks whether the given directory exists.
FTPHost::is_file(): Checks whether the given file exists.
FTPHost::loadFileContent(): Loads the content of a given file.
FTPHost::loadFolderContent(): Reads out a remote folder.
FTPHost::mkdir(): Creates a directory with given name.
FTPHost::rename(): Renames/moves a given file/directory.
FTPHost::saveFile(): Creates a file with given name and content.
FTPHost::setPort(): Stets the connection port. Standard is 21.
FTPHost::uploadFile(): Uploads a file.

Class Details

[line 40]

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
copyright:	Copyright (C) 2006 Daniel Plücken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
todo:	Functions file_exists()
since:	0.9.0.8
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$bg_color = "#FFFFFF"

[line 76]

Stores the background color of the applet.

Tags:

access:

public

Type:

string

[ Top ]

$browse_bt_label =

[line 62]

The label of the button for browsing the filesystem.

Tags:

access:

public

Type:

string

[ Top ]

$codebase = ""

[line 126]

Stores the path to the jar-archive.

Tags:

var:

access public

Type:

string

[ Top ]

$height = 90

[line 55]

Stores the value of the height-attribute of this applet.

Tags:

var:

access public

Type:

integer

[ Top ]

$mode = "PASV"

[line 154]

Stores the mode how to communicate.

Tags:

var:

access public

Type:

string

[ Top ]

$percentage_display = "true"

[line 119]

Stores whether the percentage display should be shown or not.

Tags:

access:

private

Type:

string

[ Top ]

$progressbar_bgcolor = "#000000"

[line 83]

Stores the background color of the progressbar in the applet.

Tags:

access:

public

Type:

string

[ Top ]

$progressbar_fgcolor = "#FFFFFF"

[line 90]

Stores the foreground color of the progressbar in the applet.

Tags:

access:

public

Type:

string

[ Top ]

$send_bt_label =

[line 69]

The label of the button for sending the selected file.

Tags:

access:

public

Type:

string

[ Top ]

$target_filename = ""

[line 104]

Stores the filename for uploaded file.

Tags:

access:

public

Type:

string

[ Top ]

$target_href_after_upload =

[line 112]

Stores the target url to retrieve after the selectedfile is uploaded.

Can also be a javascript (javascript:document...).

Tags:

access:

public

Type:

string

[ Top ]

$target_path = "/"

[line 97]

Stores the target path for uploaded files. Must have an ending slash.

Tags:

access:

public

Type:

string

[ Top ]

$width = 200

[line 48]

Stores the value of the width-attribute of this applet.

Tags:

var:

access public

Type:

integer

[ Top ]

$zip_filename = ""

[line 147]

Stores the filename of the target zip archive.

Tags:

var:

access public

Type:

string

[ Top ]

$zip_it = "false"

[line 133]

Stores whether the file should zipped before upload.

Tags:

var:

access public

Type:

string

[ Top ]

$zip_path = ""

[line 140]

Stores the path to the target zip archive.

Tags:

var:

access public

Type:

string

[ Top ]

Class Methods

constructor FTPUploadApplet [line 169]

FTPUploadApplet FTPUploadApplet(
string
$host, string
$user, string
$password, [string
$port = 21])

Constructor

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.2
since:	1.0
access:	public

Parameters:

string	$host
string	$user
string	$password
string	$port

[ Top ]

method get [line 364]

string get(
)

Returns a generated string based on the attributes of this HTML-Object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

[ Top ]

method setBrowseButtonLabel [line 186]

void setBrowseButtonLabel(
string
$string)

Sets the string to act as label for the browse-button.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

The label to store.

[ Top ]

method setHeight [line 275]

void setHeight(
integer
$int)

Sets how the uploaded file should be named.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

integer

$int

[ Top ]

method setMode [line 345]

void setMode(
string
$string)

Stets the connection mode (PASV or ACTIVE)

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

[ Top ]

method setSendButtonLabel [line 200]

void setSendButtonLabel(
string
$string)

Sets the string to act as label for the send-button.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

The label to store.

[ Top ]

method setShouldZipped [line 292]

void setShouldZipped(
boolean
$bool)

Sets whether the file should zipped before upload.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

boolean

$bool

[ Top ]

method setTargetAfterUpload [line 215]

void setTargetAfterUpload(
string
$string)

Sets the target url to retrieve after the selectedfile is uploaded.

Can also be a javascript (javascript:document...).

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

The label to store.

[ Top ]

method setTargetFilename [line 244]

void setTargetFilename(
string
$string)

Sets how the uploaded file should be named.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

The filename to store.

[ Top ]

method setTargetPath [line 230]

void setTargetPath(
string
$string)

Sets where to put the files to upload. The path has to have an ending slash.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

The path to store.

[ Top ]

method setWidth [line 258]

void setWidth(
integer
$int)

Sets how the uploaded file should be named.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

integer

$int

[ Top ]

method setZipFilename [line 314]

void setZipFilename(
string
$string)

Use this only if you want to upload the file AND generate separatly a zip archive of the file. If you only want to get the file to upload zipped, then it is effectual to give only the target filename.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

[ Top ]

method setZipPath [line 331]

void setZipPath(
string
$string)

Use this only if you want to upload the file AND generate separatly a zip archive of the file. If you only want to get the file to upload zipped in the target folder of the file, then it is effectual to give only the target path.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0

Parameters:

string

$string

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:11:53 +0200 by phpDocumentor 1.4.1