UploadReceiver
trait UploadReceiver mixin FormField (View source)
Represents a form field which has an Upload() instance and can upload to a folder
Note that this trait expects to be applied to a {\SilverStripe\Forms\FormField} class
Properties
| protected | Upload | $upload | Upload object (needed for validation and actually moving the temporary file created by PHP). |
|
| protected | string | $folderName | Partial filesystem path relative to /assets directory. |
Methods
Limit allowed file extensions. Empty by default, allowing all extensions.
Limit allowed file extensions by specifying categories of file types.
Returns list of extensions allowed by this field, or an empty array if there is no restriction
Details
protected
constructUploadReceiver()
Bootstrap Uploadable field
Upload
getUpload()
Retrieves the Upload handler
$this
setUpload(Upload $upload)
Sets the upload handler
$this
setAllowedExtensions(array $rules)
Limit allowed file extensions. Empty by default, allowing all extensions.
To allow files without an extension, use an empty string. See File::$allowed_extensions to get a good standard set of extensions that are typically not harmful in a webserver context. See setAllowedMaxFileSize() to limit file size by extension.
$this
setAllowedFileCategories(string $category)
Limit allowed file extensions by specifying categories of file types.
These may be 'image', 'image/supported', 'audio', 'video', 'archive', 'flash', or 'document' See File::$allowed_extensions for details of allowed extensions for each of these categories
array
getAllowedExtensions()
Returns list of extensions allowed by this field, or an empty array if there is no restriction
Upload_Validator
getValidator()
Get custom validator for this field
$this
setValidator(Upload_Validator $validator)
Set custom validator for this field
$this
setFolderName(string $folderName)
Sets the upload folder name
string
getFolderName()
Gets the upload folder name