Gets or sets an array of Progress event handlers.

Syntax

PHP

Initialize

public function &getProgress() {
}

public function setProgress($value) {
}

Property Value

Type: array

The string containing the name of Progress event handler or an array of handler names.

Remarks

This event indicates the progress of the upload. This event allows you to handle errors which can occur during the upload, display progress indicator directly in HTML code, detect when the upload is finished, etc.

Parameters

status
textual information indicating the current step of the upload.
progress
degree of completion of the upload or preparation process (in per cents).
valueMax
maximum value of the value argument for the current upload step.
value
current value of the progress.
statusText
textual information for the current step.

According to the value of the status parameter, the progress, valueMax, value, and statusText have different meanings.

status progress valueMax value statusText
START. The upload process has been started. No meaningful value.
PREPARE. Data is being prepared for the upload (thumbnails are generated; request is being constructed, etc). The upload is not started yet. Percentage of the whole upload process completion. Number of files to be prepared in the current request. Number of files in the current request that have already been prepared. Name of the file which is currently being prepared.
UPLOAD. Data is being uploaded to the server. Total size of data of the current request (in bytes). Amount of bytes of the current request that have already been sent to the server. Name of the file which is currently being uploaded to the server.
COMPLETE. The upload process has been successfully completed. No meaningful value. Response from the server which is returned by the page where files are uploaded.
CANCEL. The upload process is cancelled by a user. No meaningful value.
ERROR. Some error occurred during the upload. No meaningful value. One of the error codes:
1 - number of selected files is less than the restrictions.minFileCount value;
2 - URL specified in the uploadSettings.actionUrl property was not found;
3 - URL specified in the uploadSettings.actionUrl property has an incorrect syntax;
4 - some server-side error occurred;
6 - size of the selected file exceeds the restrictions.maxFileSize value;
7 - number of selected files exceeds the restrictions.maxFileCount value;
8 - total size of selected files exceeds the restrictions.maxTotalFileSize value;
9 - upload was aborted by a user;
13 - trial period has expired;
18 - The upload was aborted from the AfterPackageUpload event handler (the handler returns false);
19 - image dimensions are too large. Image width or height exceeds the restrictions.maxImageWidth or restrictions.maxImageHeight value;
20 - image dimensions are too small. Image width or height is less than the restrictions.minImageWidth or restrictions.minImageHeight value;
21 - size of the selected file is less than the restrictions.minFileSize value;
0 - unknown error.
Response from the server which is returned by the page where files are uploaded.