Upload_Validator
class Upload_Validator (View source)
Traits
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Config options
| default_max_file_size | array | Contains a list of the max file sizes shared by all upload fields. This is then duplicated into the "allowedMaxFileSize" instance property on construct. |
|
| use_is_uploaded_file | bool | Set to false to assume is_uploaded_file() is true, Set to true to actually call is_uploaded_file() Useful to use when testing uploads |
Properties
| protected | array | $tmpFile | Information about the temporary file produced by the PHP-runtime. |
|
| protected | $errors | |||
| public | array | $allowedMaxFileSize | Restrict filesize for either all filetypes or a specific extension, with extension-name as array-key and the size-restriction in bytes as array-value. |
|
| public | array | $allowedExtensions |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Returns the largest maximum filesize allowed across all extensions
Get maximum file size for all or specified file extension.
Set filesize maximums (in bytes or INI format).
Limit allowed file extensions. Empty by default, allowing all extensions.
Determines if the bytesize of an uploaded file is valid - can be defined on an extension-by-extension basis in $allowedMaxFileSize
Determines if the temporary file has a valid extension An empty string in the validation map indicates files without an extension.
Return the extension of the uploaded file, in lowercase Returns an empty string for files without an extension
Run through the rules for this validator checking against the temporary file set by setTmpFile() to see if the file is deemed valid or not.
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
array
getErrors()
Return all errors that occurred while validating the temporary file.
$this
clearErrors()
Clear out all errors
$this
setTmpFile(array $tmpFile)
Set information about temporary file produced by PHP.
null|int
getLargestAllowedMaxFileSize()
Returns the largest maximum filesize allowed across all extensions
int
getAllowedMaxFileSize(string $ext = null)
Get maximum file size for all or specified file extension.
$this
setAllowedMaxFileSize(array|int|string $rules)
Set filesize maximums (in bytes or INI format).
Automatically converts extensions to lowercase for easier matching.
Example:
array('*' => 200, 'jpg' => 1000, '[doc]' => '5m')
array
getAllowedExtensions()
No description
$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.
bool
isValidSize()
Determines if the bytesize of an uploaded file is valid - can be defined on an extension-by-extension basis in $allowedMaxFileSize
bool
isFileEmpty()
Determine if this file is valid but empty
bool
isValidExtension()
Determines if the temporary file has a valid extension An empty string in the validation map indicates files without an extension.
string
getFileExtension()
Return the extension of the uploaded file, in lowercase Returns an empty string for files without an extension
bool
validate()
Run through the rules for this validator checking against the temporary file set by setTmpFile() to see if the file is deemed valid or not.
bool
isValidUpload()
Check that a valid file was given for upload (ignores file size)
bool
isCompleteUpload()
Check whether the file was fully uploaded