Class Files

Responsibility: Validate everything necessary for uploaded files and check files by accept attribute rules by magic bytes.

MvcCore\Ext\Forms\Validator implements MvcCore\Ext\Forms\IValidator

Namespace: MvcCore\Ext\Forms\Validators
See: http://php.net/manual/en/features.file-upload.php
See: http://php.net/manual/en/features.file-upload.common-pitfalls.php
Located at ext-form-field-file/src/MvcCore/Ext/Forms/Validators/Files.php

Methods summary
`public string`	# `GetUploadsTmpDir( )` Complete uploaded files temporary directory. Complete uploaded files temporary directory. Returns string Implementation of `MvcCore\Ext\Forms\Validators\IFiles::GetUploadsTmpDir()`
`public stdClass[]\|null`	# `Validate( string\|array $rawSubmittedValue )` Validate `$_FILES` array items stored in request object. Check if file is valid uploaded file, sanitize file name and check file mimetype by `finfo` extension by accept attribute values. Return `NULL` for failure or success result as array with `\stdClass`(es) for each file. Validate `$_FILES` array items stored in request object. Check if file is valid uploaded file, sanitize file name and check file mimetype by `finfo` extension by accept attribute values. Return `NULL` for failure or success result as array with `\stdClass`(es) for each file. Parameters `$rawSubmittedValue` Raw user input - for this validator always `NULL`. Returns stdClass[]\|null Safe submitted files array or `NULL` if not possible to return safe value. Implementation of `MvcCore\Ext\Forms\IValidator::Validate()`
`protected null`	# `handleUploadError( integer $errorNumber, array $errorMsgArgs = [] )` Add error message arguments for specific PHP build-in errors, add error message into form session namespace, remove all tmp files and return NULL. Add error message arguments for specific PHP build-in errors, add error message into form session namespace, remove all tmp files and return NULL. Parameters `$errorNumber` `$errorMsgArgs` Returns null See http://php.net/manual/en/features.file-upload.php http://php.net/manual/en/features.file-upload.common-pitfalls.php
`protected null`	# `removeAllTmpFiles( )` Remove all currently uploaded files from PHP temporary directory and return `NULL`. Remove all currently uploaded files from PHP temporary directory and return `NULL`. Returns null

Methods inherited from MvcCore\Ext\Forms\Validator
`CreateInstance(), GetErrorMessage(), SetField(), SetForm(), __construct(), setUpFieldProps(), throwNewInvalidArgumentException()`

Methods inherited from MvcCore\Ext\Forms\Validators\IFiles
`AddBombScanners(), GetArchiveMaxCompressPercentage(), GetArchiveMaxItems(), GetArchiveMaxLevels(), GetBombScanners(), GetPngImageMaxWidthHeight(), SetArchiveMaxCompressPercentage(), SetArchiveMaxItems(), SetArchiveMaxLevels(), SetBombScanners(), SetPngImageMaxWidthHeight()`

Methods inherited from MvcCore\Ext\Forms\Fields\IMultiple
`GetMultiple(), SetMultiple()`

Methods inherited from MvcCore\Ext\Forms\Fields\IFile
`GetAccept(), GetAllowedFileNameChars(), GetCapture(), GetMaxCount(), GetMaxSize(), GetMinCount(), GetMinSize(), SetAccept(), SetAllowedFileNameChars(), SetCapture(), SetMaxCount(), SetMaxSize(), SetMinCount(), SetMinSize()`

Methods used from MvcCore\Ext\Forms\Field\Props\Multiple
`GetMultiple(), SetMultiple()`

Methods used from MvcCore\Ext\Forms\Field\Props\Files
`AddBombScanners(), GetAccept(), GetAllowedFileNameChars(), GetArchiveMaxCompressPercentage(), GetArchiveMaxItems(), GetArchiveMaxLevels(), GetBombScanners(), GetCapture(), GetMaxCount(), GetMaxSize(), GetMinCount(), GetMinSize(), GetPngImageMaxWidthHeight(), SetAccept(), SetAllowedFileNameChars(), SetArchiveMaxCompressPercentage(), SetArchiveMaxItems(), SetArchiveMaxLevels(), SetBombScanners(), SetCapture(), SetMaxCount(), SetMaxSize(), SetMinCount(), SetMinSize(), SetPngImageMaxWidthHeight()`

Methods used from MvcCore\Ext\Forms\Validators\Files\CheckRequirements
`checkRequiremets()`

Methods used from MvcCore\Ext\Forms\Validators\Files\CompleteFiles
`completeFiles(), completeFilesArray()`

Methods used from MvcCore\Ext\Forms\Validators\Files\ReadAccept
`readAccept(), readAcceptPrepareMimeTypeRegExp()`

Methods used from MvcCore\Ext\Forms\Validators\Files\Validations\FileAndSize
`validateFileAndSize()`

Methods used from MvcCore\Ext\Forms\Validators\Files\Validations\NameAndExtension
`validateNameAndExtension()`

Methods used from MvcCore\Ext\Forms\Validators\Files\Validations\MimeTypeAndExtension
`validateMimeTypeAndExtension()`

Methods used from MvcCore\Ext\Forms\Validators\Files\Validations\Bomb
`removeItemWithDir(), validateBomb(), validateBombGetPossibleType(), validateBombRecursive(), validateBombRecursiveArchive(), validateBombRecursiveArchiveEntriesSize()`

Constants inherited from MvcCore\Ext\Forms\Validators\IFiles
`MVCCORE_EXT_TOOLS_MIMES_EXTS_CLASS, UPLOAD_ERR_EMPTY_FILE, UPLOAD_ERR_FILE_BOMB, UPLOAD_ERR_MAX_FILES, UPLOAD_ERR_MAX_SIZE, UPLOAD_ERR_MIN_FILES, UPLOAD_ERR_MIN_SIZE, UPLOAD_ERR_NOT_ACCEPTED, UPLOAD_ERR_NOT_FILE, UPLOAD_ERR_NOT_POSTED, UPLOAD_ERR_NO_FILEINFO, UPLOAD_ERR_NO_MIMES_EXT, UPLOAD_ERR_RESERVED_NAME, UPLOAD_ERR_TOO_LARGE_FILE, UPLOAD_ERR_UNKNOWN_ACCEPT, UPLOAD_ERR_UNKNOWN_EXT, UPLOAD_ERR_UNKNOWN_MIME, WIN_RESERVED_FILENAMES`

Properties summary
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# [ UPLOAD_ERR_OK => "There is no error, the file uploaded with success.", // 0 UPLOAD_ERR_INI_SIZE => "Uploaded file exceeds maximum size to upload. (`{1}` bytes).", // 1 /** @bugfix: http://php.net/manual/en/features.file-upload.php#74692 */ //UPLOAD_ERR_FORM_SIZE => "Uploaded file exceeds max. size to upload: `{1}`.", // 2 UPLOAD_ERR_PARTIAL => "Uploaded file was only partially uploaded.", // 3 UPLOAD_ERR_NO_FILE => "No file was uploaded.", // 4 UPLOAD_ERR_NO_TMP_DIR => "Missing a temporary folder for uploaded file.", // 6 UPLOAD_ERR_CANT_WRITE => "Failed to write uploaded file to disk.", // 7 UPLOAD_ERR_EXTENSION => "System extension stopped the file upload.", // 8 self::UPLOAD_ERR_MIN_FILES => "Field allows to upload `{1}` file(s) at minimum.", // 9 self::UPLOAD_ERR_MAX_FILES => "Field allows to upload `{1}` file(s) at maximum.", // 10 self::UPLOAD_ERR_NOT_POSTED => "File wasn't uploaded via HTTP POST.", // 11 self::UPLOAD_ERR_NOT_FILE => "Uploaded file is not valid file.", // 12 self::UPLOAD_ERR_EMPTY_FILE => "Uploaded file is empty.", // 13 self::UPLOAD_ERR_TOO_LARGE_FILE => "Uploaded file is too large.", // 14 self::UPLOAD_ERR_MIN_SIZE => "One of uploaded files is too small. Min. required size is `{1}`.", // 15 self::UPLOAD_ERR_MAX_SIZE => "One of uploaded files is too large. Max. allowed size is `{1}`.", // 16 self::UPLOAD_ERR_NO_FILEINFO => "System extension for files recognition is missing.", // 17 self::UPLOAD_ERR_NO_MIMES_EXT => "System extension for mime type(s) and extensions is missing.", // 18 self::UPLOAD_ERR_UNKNOWN_ACCEPT => "Unknown accept attribute value found: `{1}`.", // 19 self::UPLOAD_ERR_UNKNOWN_EXT => "Unknown file mimetype found for accept file extension: `{1}`.", // 20 self::UPLOAD_ERR_UNKNOWN_MIME => "Unknown file extension found for accept file mimetype: `{1}`.", // 21 self::UPLOAD_ERR_RESERVED_NAME => "Uploaded file name has system reserved name (`{1}`).", // 22 self::UPLOAD_ERR_NOT_ACCEPTED => "Uploaded file is not in the expected file format (`{1}`).", // 23 self::UPLOAD_ERR_FILE_BOMB => "Uploaded file has been evaluated as a potential file bomb (`{1}`).",// 24 ]
`protected static array`	`$fieldSpecificProperties` Field specific values (camel case) and their validator default values. Field specific values (camel case) and their validator default values.	# `[ 'multiple' => NULL, 'accept' => NULL, 'allowedFileNameChars' => \MvcCore\Ext\Forms\Fields\File::ALLOWED_FILE_NAME_CHARS_DEFAULT, 'minCount' => NULL, 'maxCount' => NULL, 'minSize' => NULL, 'maxSize' => NULL, 'archiveMaxLevels' => NULL, 'archiveMaxItems' => NULL, 'archiveMaxCompressPercentage' => NULL, 'pngImageMaxWidthHeight' => NULL, 'bombScanners' => NULL, ]`
`protected stdClass[]`	`$files` Uploaded files collection completed from request object from global `$_FILES` array. Every item in array is `\stdClass` object with following records: - `name` - string from `$_FILES['name']`, sanitized by `basename()`, by max. length and by allowed characters. - `type` - string from `$_FILES['type']`, checked by `finfo` PHP extension and allowed file extensions for mime type. - `tmpFullPath` - string from `$_FILES['tmp_name']`, checked by `is_uploaded_file()`. - `error` - int from `$_FILES['error']`, always `0` in success upload. - `size` - int from `$_FILES['size']`, checked by `filesize()`, - `extension` - lower case file extension parsed by `pathinfo()` from sanitized `name` record. Uploaded files collection completed from request object from global `$_FILES` array. Every item in array is `\stdClass` object with following records: - `name` - string from `$_FILES['name']`, sanitized by `basename()`, by max. length and by allowed characters. - `type` - string from `$_FILES['type']`, checked by `finfo` PHP extension and allowed file extensions for mime type. - `tmpFullPath` - string from `$_FILES['tmp_name']`, checked by `is_uploaded_file()`. - `error` - int from `$_FILES['error']`, always `0` in success upload. - `size` - int from `$_FILES['size']`, checked by `filesize()`, - `extension` - lower case file extension parsed by `pathinfo()` from sanitized `name` record.	# `[]`
`protected array`	`$mimeTypesAndExts` Array with string mimetypes keys and values as arrays with string extensions. Array with string mimetypes keys and values as arrays with string extensions.	# `[]`
`protected string\|null`	`$uploadsTmpDir` Uploaded files temporary directory, completed in method: `$this->checkRequiremets();`. Uploaded files temporary directory, completed in method: `$this->checkRequiremets();`.	# `NULL`

Properties inherited from MvcCore\Ext\Forms\Validator
`$field, $form, $toolClass`

Properties used from MvcCore\Ext\Forms\Field\Props\Multiple
`$multiple`

Properties used from MvcCore\Ext\Forms\Field\Props\Files
`$accept, $allowedFileNameChars, $archiveMaxCompressPercentage, $archiveMaxItems, $archiveMaxLevels, $bombScanners, $capture, $maxCount, $maxSize, $minCount, $minSize, $pngImageMaxWidthHeight`

Classes

Interfaces

Traits

Exceptions

Functions

Class Files

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

See

Returns