KoolUploader Class [PHP]

Summary

Properties Description
allowedExtension Get or set list of allowed file extensions.
handlePage Get or set the page which handle upload request
height Get or set the height of KoolUploader.
id Get or set the id for KoolUploader.
maxFileSize Get or set maximum size (in bytes) of uploading file
progressTracking Get or set whether progress tracking is enabled
scriptFolder Get or set folder which contain core file "kooluploader.php".
showProgressBar Get or set whether the progress bar will be shown
styleFolder Get or set folder which contain css style for KoolUploader.
texts Get or set text for buttons and messages of KooUploader.
updateProgressInterval Get or set number of milisecond KoolUploader will send request to track uploading progress.
uploadedFiles Get the information of uploaded files.
width Get or set the width of KoolUploader.
Methods Description
LoadXML Create KoolUploader with XML content.
Render Render the KoolUploader
RegisterScript Return html to register js library for KoolUploader.
RegisterCSS Return html to register CSS for KoolUploader
RenderUploader Return html content of KoolUploader body
StartupScript Return js code to inititate KoolUploader

Properties Detail

allowedExtensionTop

string allowedExtension

Get or set list of allowed file extensions.

Show/Hide Code

Supported from version: 1.0.0.0

handlePageTop

string handlePage

Get or set the page which handle upload request

Show/Hide Code

Supported from version: 1.0.0.0

heightTop

string height

Get or set the height of KoolUploader.

Default value : "200px"

Show/Hide Code

Supported from version: 1.0.0.0

idTop

string id

Get or set the id for KoolUploader. This id will be use as variable name of KoolUploader at client-side.

Show/Hide Code

Supported from version: 1.0.0.0

maxFileSizeTop

int maxFileSize

Get or set maximum size (in bytes) of uploading file

Show/Hide Code

Supported from version: 1.0.0.0

progressTrackingTop

bool progressTracking

Get or set whether progress tracking is enabled

Show/Hide Code

Supported from version: 1.0.0.0

scriptFolderTop

string scriptFolder

Get or set folder which contain core file "kooluploader.php". Normally the path to script folder is automatically added, however in some cases you may need to set it manually.

Show/Hide Code

Supported from version: 1.0.0.0

showProgressBarTop

bool showProgressBar

Get or set whether the progress bar will be shown

Show/Hide Code

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for KoolUploader.

Show/Hide Code

Supported from version: 1.0.0.0

textsTop

array texts

Get or set text for buttons and messages of KooUploader. This array is very useful to customize KoolUploader with your own message and button text.

Allowed values :

  • "BUTTON_ADD" :
  • "BUTTON_UPLOAD_ALL" :
  • "BUTTON_CLEAR_ALL" :
  • "BUTTON_UPLOAD" :
  • "BUTTON_REMOVE" :
  • "BUTTON_CANCEL" :
  • "MESSAGE_UPLOAD_SUCCESSFUL" :
  • "MESSAGE_FILE_NOT_ALLOWED" :
  • "MESSAGE_FILE_BIGGER_THAN_PHP_ALLOW" :
  • "MESSAGE_FILE_BIGGER_THAN_FORM_ALLOW" :
  • "MESSAGE_ONLY_PART_OF_FILE_UPLOADED" :
  • "MESSAGE_UPLOAD_FAILED" :
  • "MESSAGE_UPLOAD_CANCEL" :

Show/Hide Code

Supported from version: 1.0.0.0

updateProgressIntervalTop

int updateProgressInterval

Get or set number of milisecond KoolUploader will send request to track uploading progress.

Show/Hide Code

Supported from version: 1.0.0.0

uploadedFilesTop

array uploadedFiles

Get the information of uploaded files. After having done with upload files at client-side, the page is submitted back. The information of all uloaded files will be posted back as well. When KoolUploader object initiates, Those information will be extracted and saved into uploadedFiles property.

Show/Hide Code

Supported from version: 1.0.0.0

widthTop

string width

Get or set the width of KoolUploader.

Default value : "300px"

Show/Hide Code

Supported from version: 1.0.0.0

Methods Detail

LoadXMLTop

function LoadXML()

Create KoolUploader with XML content. The input value may be string or XmlDocument.

Show/Hide Code

Supported from version: 1.2.0.0

RenderTop

void Render()

Render the KoolUploader

Show/Hide Code

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolUploader.

Show/Hide Code

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolUploader

Show/Hide Code

Supported from version: 1.0.0.0

RenderUploaderTop

string RenderUploader()

Return html content of KoolUploader body

Show/Hide Code

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate KoolUploader

Show/Hide Code

Supported from version: 1.0.0.0