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.

Properties

static private array $default_max_file_size Contains a list of the max file sizes shared by all upload fields. This is then duplicated into the "allowedMaxFileSize" instance property on construct.
static private bool $use_is_uploaded_file 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
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.
array $allowedExtensions

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

array
getErrors()

Return all errors that occurred while validating the temporary file.

clearErrors()

Clear out all errors

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.

setAllowedMaxFileSize(array|int $rules)

Set filesize maximums (in bytes or INI format).

array
getAllowedExtensions()

No description

setAllowedExtensions(array $rules)

Limit allowed file extensions. Empty by default, allowing all extensions.

bool
isValidSize()

Determines if the bytesize of an uploaded file is valid - can be defined on an extension-by-extension basis in {@link $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 {@link 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

Details

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class Optional classname to create, if the called class should not be used

Return Value

Injectable

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

array getErrors()

Return all errors that occurred while validating the temporary file.

Return Value

array

clearErrors()

Clear out all errors

setTmpFile(array $tmpFile)

Set information about temporary file produced by PHP.

Parameters

array $tmpFile

null|int getLargestAllowedMaxFileSize()

Returns the largest maximum filesize allowed across all extensions

Return Value

null|int

int getAllowedMaxFileSize(string $ext = null)

Get maximum file size for all or specified file extension.

Parameters

string $ext

Return Value

int

setAllowedMaxFileSize(array|int $rules)

Set filesize maximums (in bytes or INI format).

Automatically converts extensions to lowercase for easier matching.

Example: array('*' => 200, 'jpg' => 1000, '[doc]' => '5m')

Parameters

array|int $rules

array getAllowedExtensions()

Return Value

array

setAllowedExtensions(array $rules)

Limit allowed file extensions. Empty by default, allowing all extensions.

To allow files without an extension, use an empty string. See {@link File::$allowed_extensions} to get a good standard set of extensions that are typically not harmful in a webserver context. See {@link setAllowedMaxFileSize()} to limit file size by extension.

Parameters

array $rules List of extensions

bool isValidSize()

Determines if the bytesize of an uploaded file is valid - can be defined on an extension-by-extension basis in {@link $allowedMaxFileSize}

Return Value

bool

bool isFileEmpty()

Determine if this file is valid but empty

Return Value

bool

bool isValidExtension()

Determines if the temporary file has a valid extension An empty string in the validation map indicates files without an extension.

Return Value

bool

string getFileExtension()

Return the extension of the uploaded file, in lowercase Returns an empty string for files without an extension

Return Value

string

bool validate()

Run through the rules for this validator checking against the temporary file set by {@link setTmpFile()} to see if the file is deemed valid or not.

Return Value

bool

bool isValidUpload()

Check that a valid file was given for upload (ignores file size)

Return Value

bool

bool isCompleteUpload()

Check whether the file was fully uploaded

Return Value

bool