Docs For Class HTML_Progress

HTML_Progress_Uploader (Constructor) [line 121]

HTML_Progress_Uploader HTML_Progress_Uploader(
[string
$formName = 'ProgressUploader'], [array
$attributes = array()])

The progress uploader class constructor

Since: 1.1
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

string	`$formName`	—	(optional) Name of monitor dialog box (QuickForm)
array	`$attributes`	—	(optional) List of renderer options

[ Top ]

accept [line 297]

void accept(

&$renderer, object
$renderer)

Accepts a renderer

Since: 1.1
Access: public

Parameters:

object	`$renderer`	—	An HTML_QuickForm_Renderer object
	`&$renderer`	—

[ Top ]

getScript [line 259]

string getScript(
)

Returns progress javascript.

Since: 1.1
Access: public

[ Top ]

getStyle [line 247]

string getStyle(
)

Returns progress styles (StyleSheet).

Since: 1.1
Access: public

[ Top ]

isCanceled [line 234]

bool isCanceled(
)

Returns TRUE if progress was canceled by user, FALSE otherwise.

Since: 1.1
Access: public

[ Top ]

isStarted [line 221]

bool isStarted(
)

Returns TRUE if progress was started by user, FALSE otherwise.

Since: 1.1
Access: public

[ Top ]

logoff [line 474]

void logoff(
)

Disconnect from a remote FTP server.

(Timeout is default set to 90 sec.)

Since: 1.1
Access: public

[ Top ]

logon [line 450]

mixed logon(
string
$user, string
$pass, string
$host, [integer
$port = 21], [integer
$timeout = 90])

Connect on a remote FTP server and login as $user.

Return: TRUE on success, and PEAR_Error on failure
Since: 1.1
Access: public

Parameters:

string	`$host`	—	FTP server to connect to.
string	`$user`	—	Username.
string	`$pass`	—	Password.
integer	`$port`	—	(optional) an alternate port to connect to.
integer	`$timeout`	—	(optional) the timeout for all subsequent network operations.

[ Top ]

moveTo [line 323]

mixed moveTo(
string
$dest, [boolean
$overwrite = false])

Uploads the files asynchronously, so the class can perform other operations while files are being uploaded, such : display a progress bar in indeterminate mode.

Return: a null array if all files transfered
See: FTP_Upload::setFiles()
Since: 1.1
Access: public

Parameters:

string	`$dest`	—	Changes from current to the specified directory.
boolean	`$overwrite`	—	(optional) overwrite existing files.

[ Top ]

setFiles [line 416]

void setFiles(
mixed
$files, [boolean
$check = true])

Set a list of files to upload on the ftp server.

Since: 1.1
Access: public

Parameters:

mixed	`$files`	—	List of files to transfer to FTP server.
boolean	`$check`	—	(optional) Restrict files to valid extensions only.

[ Top ]

setProgressElement [line 194]

void setProgressElement(

&$bar, object
$bar)

Attach a progress bar to this uploader.

Since: 1.1
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

object	`$bar`	—	a html_progress instance
	`&$bar`	—

[ Top ]

setValidExtensions [line 396]

void setValidExtensions(
mixed
$exts)

Restricts the valid extensions on file uploads.

Since: 1.1
Access: public

Parameters:

mixed $exts — File extensions to validate

[ Top ]

toHtml [line 283]

string toHtml(
)

Returns Uploader forms as a Html string.

Since: 1.1
Access: public

[ Top ]

Class: HTML_Progress_Uploader

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$buttonCancel =

$buttonStart =

$captionMask =

$windowname =

Method Detail

HTML_Progress_Uploader (Constructor) [line 121]

Parameters:

accept [line 297]

Parameters:

getScript [line 259]

getStyle [line 247]

isCanceled [line 234]

isStarted [line 221]

logoff [line 474]

logon [line 450]

Parameters:

moveTo [line 323]

Parameters:

setFiles [line 416]

Parameters:

setProgressElement [line 194]

Parameters:

setValidExtensions [line 396]

Parameters:

toHtml [line 283]