Represents a file received through a multipart/form-data web request. Uploaded files are returned by the public REQUEST object's files() function and are not normally constructed directly by a YASS program.
The object keeps the upload in a server-side temporary file until it is saved or read. Its four metadata properties are public, and all eight functions require permission level 4.
Availability: The UploadedFile object was introduced in ZPE 1.14.11.
Properties
name⇒ string — the original filename supplied by the client.type⇒ string — the uploaded file MIME type.size⇒ number — the uploaded file size in bytes.error⇒ number — the upload error code;0represents success.
Object functions
- contents [1.14.11+]
Returns the uploaded file contents as a ByteStream.
- error [1.14.11+]
Returns the upload error code, where zero means success.
- name [1.14.11+]
Returns the original client filename.
- save [1.14.11+]
Saves the uploaded file to the specified path.
- size [1.14.11+]
Returns the uploaded file size in bytes.
- temporary_path [1.14.11+]
Returns the server-side temporary path for the upload.
- type [1.14.11+]
Returns the uploaded file MIME type.
- valid [1.14.11+]
Reports whether the uploaded file was received successfully.
Example
$upload = REQUEST->files()["avatar"] if ($upload->valid()) $upload->save("uploads/" + $upload->name()) end if
There are no comments on this page.
Comments are welcome and encouraged, including disagreement and critique. However, this is not a space for abuse. Disagreement is welcome; personal attacks, harassment, or hate will be removed instantly. This site reflects personal opinions, not universal truths. If you can’t distinguish between the two, this probably isn’t the place for you. The system temporarily stores IP addresses and browser user agents for the purposes of spam prevention, moderation, and safeguarding. This data is automatically removed after fourteen days. Your email address is stored so that replies can be sent to your email address.
Comments powered by BalfComment