Class TFileUpload
Direct Known Sub-classes:
TFileUpload class
TFileUpload displays a file upload field on a page. Upon postback, the text entered into the field will be treated as the name of the file that will be uploaded to the server. The property HasFile indicates whether the file upload is successful. If successful, the file may be obtained by calling saveAs to save it at a specified place. You can use FileName, FileType, FileSize to get the original client-side file name, the file mime type, and the file size information. If the upload is not successful, ErrorCode contains the error code describing the cause of failure. TFileUpload raises OnFileUpload event if a file is uploaded (whether it succeeds or not).
| Constants Inherited From TControl |
|
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID,
|
| Method Summary |
|
protected
void
|
Sets name attribute to the unique ID of the control.
|
|
boolean
|
Returns a value indicating whether postback has caused the control data change.
|
|
integer
|
Returns an error code describing the status of this file uploading.
|
|
string
|
|
|
integer
|
|
|
string
|
|
|
boolean
|
|
|
bool
|
Returns true if this control validated successfully.
|
|
string
|
|
|
integer
|
|
|
protected
string
|
|
|
mixed
|
Returns the original file name as the property value to be validated.
|
|
boolean
|
Loads user input data.
|
|
void
|
This method is invoked when a file is uploaded during a postback.
|
|
void
|
Sets Enctype of the form on the page.
|
|
void
|
Raises postdata changed event.
|
|
boolean
|
saveAs
( string $fileName, boolean $deleteTempFile)
Saves the uploaded file.
|
|
void
|
|
|
void
|
Sets the maximum size that a file can be uploaded.
|
| Methods Inherited From TWebControl |
|
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
|
| Methods Inherited From TControl |
|
TControl::addedControl(), TControl::addParsedObject(), TControl::addToPostDataLoader(), TControl::applyStyleSheetSkin(), TControl::autoBindProperty(), TControl::autoDataBindProperties(), TControl::bindProperty(), TControl::broadcastEvent(), TControl::bubbleEvent(), TControl::clearChildState(), TControl::clearControlState(), TControl::clearNamingContainer(), TControl::clearViewState(), TControl::convertUniqueIdToClientId(), TControl::createChildControls(), TControl::createControlCollection(), TControl::dataBind(), TControl::dataBindChildren(), TControl::dataBindProperties(), TControl::ensureChildControls(), TControl::findControl(), TControl::findControlsByID(), TControl::findControlsByType(), TControl::focus(), TControl::getAdapter(), TControl::getAllowChildControls(), TControl::getAttribute(), TControl::getAttributes(), TControl::getChildControlsCreated(), TControl::getClientID(), TControl::getControls(), TControl::getControlStage(), TControl::getControlState(), TControl::getCustomData(), TControl::getEnabled(), TControl::getEnableTheming(), TControl::getEnableViewState(), TControl::getHasAdapter(), TControl::getHasAttributes(), TControl::getHasChildInitialized(), TControl::getHasControls(), TControl::getHasInitialized(), TControl::getHasLoaded(), TControl::getHasLoadedPostData(), TControl::getHasPreRendered(), TControl::getID(), TControl::getNamingContainer(), TControl::getPage(), TControl::getParent(), TControl::getRegisteredObject(), TControl::getSkinID(), TControl::getSourceTemplateControl(), TControl::getTemplateControl(), TControl::getUniqueID(), TControl::getViewState(), TControl::getVisible(), TControl::hasAttribute(), TControl::initRecursive(), TControl::isDescendentOf(), TControl::isObjectRegistered(), TControl::loadRecursive(), TControl::loadState(), TControl::loadStateRecursive(), TControl::onDataBinding(), TControl::onInit(), TControl::onLoad(), TControl::onPreRender(), TControl::onUnload(), TControl::preRenderRecursive(), TControl::raiseBubbleEvent(), TControl::registerObject(), TControl::removeAttribute(), TControl::removedControl(), TControl::render(), TControl::renderChildren(), TControl::renderControl(), TControl::saveState(), TControl::saveStateRecursive(), TControl::setAdapter(), TControl::setAttribute(), TControl::setChildControlsCreated(), TControl::setControlStage(), TControl::setControlState(), TControl::setCustomData(), TControl::setEnabled(), TControl::setEnableTheming(), TControl::setEnableViewState(), TControl::setID(), TControl::setPage(), TControl::setSkinID(), TControl::setTemplateControl(), TControl::setViewState(), TControl::setVisible(), TControl::trackViewState(), TControl::traverseChildControls(), TControl::unbindProperty(), TControl::unloadRecursive(), TControl::unregisterObject(), TControl::__get()
|
| Methods Inherited From TComponent |
|
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
| Constant Summary |
| int
|
MAX_FILE_SIZE |
Maximum file size (in bytes) allowed to be uploaded, defaults to 1MB.
|
| Method Details |
addAttributesToRender
| protected void addAttributesToRender |
(THtmlWriter $writer ) |
Sets name attribute to the unique ID of the control.
This method overrides the parent implementation with additional file update control specific attributes.
| Input |
|---|
| THtmlWriter | $writer | the writer used for the rendering purpose |
| Output |
|---|
| Exception |
|---|
|
getDataChanged
| public boolean getDataChanged |
() |
Returns a value indicating whether postback has caused the control data change.
This method is required by the IPostBackDataHandler interface.
| Output |
|---|
|
boolean
| whether postback has caused the control data change. False if the page is not in postback mode. |
| Exception |
|---|
|
getErrorCode
| public integer getErrorCode |
() |
Returns an error code describing the status of this file uploading.
| Output |
|---|
|
integer
| the error code |
| Exception |
|---|
|
getFileName
| public string getFileName |
() |
| Output |
|---|
|
string
| the original full path name of the file on the client machine |
| Exception |
|---|
|
getFileSize
| public integer getFileSize |
() |
| Output |
|---|
|
integer
| the actual size of the uploaded file in bytes |
| Exception |
|---|
|
getFileType
| public string getFileType |
() |
| Output |
|---|
|
string
| the MIME-type of the uploaded file (such as "image/gif"). This mime type is not checked on the server side and do not take its value for granted. |
| Exception |
|---|
|
getHasFile
| public boolean getHasFile |
() |
| Output |
|---|
|
boolean
| whether the file is uploaded successfully |
| Exception |
|---|
|
getIsValid
| public bool getIsValid |
() |
Returns true if this control validated successfully.
Defaults to true.
| Output |
|---|
|
bool
| wether this control validated successfully. |
| Exception |
|---|
|
getLocalName
| public string getLocalName |
() |
| Output |
|---|
|
string
| the local name of the file (where it is after being uploaded). Note, PHP will delete this file automatically after finishing this round of request. |
| Exception |
|---|
|
getMaxFileSize
| public integer getMaxFileSize |
() |
| Output |
|---|
|
integer
| the maximum file size, defaults to 1MB (1048576 bytes). |
| Exception |
|---|
|
getTagName
| protected string getTagName |
() |
| Output |
|---|
|
string
| tag name of the file upload control |
| Exception |
|---|
|
getValidationPropertyValue
| public mixed getValidationPropertyValue |
() |
Returns the original file name as the property value to be validated.
This method is required by IValidatable property.
| Output |
|---|
|
mixed
| the property value to be validated |
| Exception |
|---|
|
loadPostData
| public boolean loadPostData |
(string $key , array $values ) |
Loads user input data.
This method is primarly used by framework developers.
| Input |
|---|
| string | $key | the key that can be used to retrieve data from the input data collection |
| array | $values | the input data collection |
| Output |
|---|
|
boolean
| whether the data of the control has been changed |
| Exception |
|---|
|
onFileUpload
This method is invoked when a file is uploaded during a postback.
The method raises OnFileUpload event to fire up the event handler. If you override this method, be sure to call the parent implementation so that the event delegates can be invoked.
| Input |
|---|
| TEventParameter | $param | event parameter to be passed to the event handlers |
| Output |
|---|
| Exception |
|---|
|
onPreRender
| public void onPreRender |
(mixed $param ) |
Sets Enctype of the form on the page.
This method overrides the parent implementation and is invoked before render.
| Input |
|---|
| mixed | $param | event parameter |
| Output |
|---|
| Exception |
|---|
|
raisePostDataChangedEvent
| public void raisePostDataChangedEvent |
() |
Raises postdata changed event.
This method calls onFileUpload method. This method is primarly used by framework developers.
|
saveAs
| public boolean saveAs |
(string $fileName , boolean $deleteTempFile ) |
Saves the uploaded file.
| Input |
|---|
| string | $fileName | the file name used to save the uploaded file |
| boolean | $deleteTempFile | whether to delete the temporary file after saving. If true, you will not be able to save the uploaded file again. |
| Output |
|---|
|
boolean
| true if the file saving is successful |
| Exception |
|---|
|
setIsValid
| public void setIsValid |
(bool $value ) |
| Input |
|---|
| bool | $value | wether this control is valid. |
| Output |
|---|
| Exception |
|---|
|
setMaxFileSize
| public void setMaxFileSize |
(int $size ) |
Sets the maximum size that a file can be uploaded.
Note, this is an advisory value to the browser. Sets this property with a reasonably large size to save users the trouble of waiting for a big file being transferred only to find that it was too big and the transfer failed.
| Input |
|---|
| int | $size | the maximum upload size allowed for a file. |
| Output |
|---|
| Exception |
|---|
|
| Constant Details |
MAX_FILE_SIZE
Maximum file size (in bytes) allowed to be uploaded, defaults to 1MB.
|
|
